Skip to main content
POST
/
v3
/
database-validation
curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=AUS" \
  -F "services=aus_residential_lookup" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F "landline=+15550101001" \
  -F "phone=+15550101000"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "AUS",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "aus_residential_lookup",
      "service_name": "Australia Residential Lookup",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe",
        "middle_name": "Demo"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.didit.me/llms.txt

Use this file to discover all available pages before exploring further.

Uses the input phone number as the primary lookup key against the Residential and Citizens databases. Didit exposes this service through POST /v3/database-validation/ so you can verify the submitted data against the authoritative source and receive normalized match results.

​
Coverage

  • Coverage: ~ 65%
  • Country: Australia
  • Service ID: aus_residential_lookup
  • Data domain: Address
  • Category: Residential

​
Inputs

FieldRequiredExample
first_nameYesJohn
last_nameYesDoe
date_of_birthYes1990-01-01
landlineYes+15550101001
phoneYes+15550101000
middle_nameNoDemo
genderNoM
addressNo123 Sample Street, Sample City, 10001
  • Required inputs: first_name, last_name, date_of_birth, landline, phone
  • Optional inputs: middle_name, gender, address
  • Consent: Not required
  • Workflow availability: Standalone API only
  • Coverage: ~ 65%
  • Price: $0.32 per successful query

​
Body parameters

​
issuing_state
string
required
ISO 3166-1 alpha-3 country code for this database service.Example: AUS
​
services
string
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: aus_residential_lookup
​
first_name
string
required
Given name to validate.Example: John
​
last_name
string
required
Family name to validate.Example: Doe
​
date_of_birth
string
required
Date of birth in YYYY-MM-DD format.Example: 1990-01-01
​
landline
string
required
Landline phone number.Example: +15550101001
​
phone
string
required
Phone number in international format.Example: +15550101000
​
middle_name
string
Middle name, when available.Example: Demo
​
gender
string
Gender value, when required by the database.Example: M
​
address
string
Complete address string. Didit can split this into structured address elements when possible.Example: 123 Sample Street, Sample City, 10001

​
Input rules & validation notes

  • address is optional for this service. You can send one complete address string and Didit will split it into structured address elements when possible, or you can send the structured fields explicitly.
  • address_element_1 is the street address, including street number and street type.
  • address_element_2 is optional unit, building, floor, or extra address line. Didit only sends it when you provide it explicitly.
  • address_element_3 is suburb, district, locality, or neighborhood.
  • address_element_4 is city, town, state, province, or region.
  • address_element_5 is postcode or postal code. postal_code is accepted as an alias.
  • Address-based database services need at least address_element_1 plus one searchable component such as address_element_3, address_element_4, or address_element_5; requests rejected before source lookup are not charged.

​
How to call it

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=AUS" \
  -F "services=aus_residential_lookup" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01" \
  -F "landline=+15550101001" \
  -F "phone=+15550101000"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "AUS",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "aus_residential_lookup",
      "service_name": "Australia Residential Lookup",
      "source_data": {
        "address": "123 Sample Street",
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe",
        "middle_name": "Demo"
      },
      "validation": {
        "date_of_birth": "full_match",
        "full_name": "full_match"
      }
    }
  ]
}

​
Returned data

The exact fields surfaced in source_data depend on what the registry returns. The generated example for aus_residential_lookup currently documents this normalized shape:
  • address
  • date_of_birth
  • first_name
  • last_name
  • middle_name

​
Pricing & SLAs

Australia Residential Lookup queries are billed only when Didit receives a conclusive result from the validation source.
  • Per-call price: $0.32 USD.
  • Billing: per successful query. You are not charged when the registry is unreachable, when required fields are missing, or when the request is rejected before reaching the source.
  • Latency: typical p95 < 2 s.
  • Availability: 99.9% per quarter on Didit’s side; downstream source availability varies by country and dataset.

​
Continue reading