Skip to main content
POST
Retrieves the registered Department of Home Affairs photograph for a South African ID number. 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_dha_photo
  • Data domain: Biometric
  • Category: Government

Inputs

  • Required inputs: national_id
  • Optional inputs: vendor_data
  • Consent: Required
  • Workflow availability: Available in workflow
  • Coverage:
  • Price: $1.10 per successful query

Body parameters

issuing_state
string
default:"ZAF"
required
ISO 3166-1 alpha-3 country code for this database service.Example: ZAF
services
string
default:"zaf_dha_photo"
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: zaf_dha_photo
Explicit end-user consent for this service.Example: true
national_id
string
default:"SAMPLE-NID-12345"
required
National identity number for this service.Example: SAMPLE-NID-12345
vendor_data
string
default:"user-1234"
Your stable user reference for this person, such as your internal user ID. Didit uses it to link standalone checks to the same end user and reduce duplicate-detection noise.Example: user-1234

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

Returned data

The exact fields surfaced in source_data depend on what the registry returns. The generated example for zaf_dha_photo currently documents this normalized shape:
  • birth_place_country_code
  • deceased
  • first_name
  • id_blocked
  • identification_number
  • last_name
  • marital_status
  • on_hanis_biometric_register
  • on_national_population_register
  • photo_base64
  • smart_card_issued
  • transaction_number

Pricing & SLAs

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