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=NZL" \
  -F "services=nzl_new_zealand_citizenship" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "NZL",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "nzl_new_zealand_citizenship",
      "service_name": "DIA - New Zealand Citizenship",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "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.

DIA Citizenship verification service. 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: > 10%
  • Country: New Zealand
  • Service ID: nzl_new_zealand_citizenship
  • Data domain: Identity
  • Category: Citizenship

​
Inputs

FieldRequiredExample
first_nameYesJohn
last_nameYesDoe
date_of_birthYes1990-01-01
  • Required inputs: first_name, last_name, date_of_birth
  • Optional inputs: —
  • Consent: Required
  • Workflow availability: Available in workflow
  • Coverage: > 10%
  • Price: $0.84 per successful query

​
Body parameters

​
issuing_state
string
required
ISO 3166-1 alpha-3 country code for this database service.Example: NZL
​
services
string
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: nzl_new_zealand_citizenship
​
consent
boolean
required
Explicit end-user consent for this service.Example: true
​
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

​
Input rules & validation notes

  • Send the fields listed above exactly as captured from the user or document.
  • Didit validates required fields before calling the database. 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=NZL" \
  -F "services=nzl_new_zealand_citizenship" \
  -F "consent=true" \
  -F "first_name=John" \
  -F "last_name=Doe" \
  -F "date_of_birth=1990-01-01"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "NZL",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "nzl_new_zealand_citizenship",
      "service_name": "DIA - New Zealand Citizenship",
      "source_data": {
        "date_of_birth": "1990-01-01",
        "first_name": "John",
        "last_name": "Doe"
      },
      "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 nzl_new_zealand_citizenship currently documents this normalized shape:
  • date_of_birth
  • first_name
  • last_name

​
Pricing & SLAs

DIA - New Zealand Citizenship queries are billed only when Didit receives a conclusive result from the validation source.
  • Per-call price: $0.84 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