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=ZAF" \
  -F "services=zaf_contactability" \
  -F "consent=true" \
  -F "national_id=SAMPLE-NID-12345"
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_contactability",
      "service_name": "South Africa - Contactability Lookup",
      "source_data": {
        "contact_email": "alex.sample@example.com",
        "contact_phone_numbers": "+15550101000",
        "date_of_birth": "1990-01-01",
        "deceased": "sample_value",
        "first_name": "John",
        "gender": "M",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "phone_history_count": "+15550101000"
      },
      "validation": {
        "identification_number": "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.

Returns known phone numbers, emails, and addresses tied to a South African individual. 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:
  • Country: South Africa
  • Service ID: zaf_contactability
  • Data domain: Telecom
  • Category: Telecom

Inputs

FieldRequiredExample
national_idYesSAMPLE-NID-12345
  • Required inputs: national_id
  • Optional inputs:
  • Consent: Required
  • Workflow availability: Available in workflow
  • Coverage:
  • Price: $0.30 per successful query

Body parameters

issuing_state
string
required
ISO 3166-1 alpha-3 country code for this database service.Example: ZAF
services
string
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: zaf_contactability
Explicit end-user consent for this service.Example: true
national_id
string
required
National identity number for this service.Example: SAMPLE-NID-12345

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=ZAF" \
  -F "services=zaf_contactability" \
  -F "consent=true" \
  -F "national_id=SAMPLE-NID-12345"
{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_contactability",
      "service_name": "South Africa - Contactability Lookup",
      "source_data": {
        "contact_email": "alex.sample@example.com",
        "contact_phone_numbers": "+15550101000",
        "date_of_birth": "1990-01-01",
        "deceased": "sample_value",
        "first_name": "John",
        "gender": "M",
        "identification_number": "SAMPLE-ID-12345",
        "last_name": "Doe",
        "phone_history_count": "+15550101000"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}

Returned data

The exact fields surfaced in source_data depend on what the registry returns. The generated example for zaf_contactability currently documents this normalized shape:
  • contact_email
  • contact_phone_numbers
  • date_of_birth
  • deceased
  • first_name
  • gender
  • identification_number
  • last_name
  • phone_history_count

Pricing & SLAs

South Africa - Contactability Lookup queries are billed only when Didit receives a conclusive result from the validation source.
  • Per-call price: $0.30 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