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_refugee" \
  -F "vendor_data=user-1234" \
  -F "refugee_file_number=RF123456"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_refugee",
      "service_name": "South Africa - Refugee File Verification",
      "source_data": {},
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
Verifies a refugee file number against the South African Department of Home Affairs refugee register. 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_refugee
  • Data domain: Identity
  • Category: Government

​
Inputs

FieldRequiredExample
refugee_file_numberYesRF123456
phone_numberNo+15550101000
emailNojohn.doe@example.com
vendor_dataNouser-1234
  • Required inputs: refugee_file_number
  • Optional inputs: phone_number, email, vendor_data
  • Consent: Not required
  • Workflow availability: Standalone API only
  • 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_refugee"
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: zaf_refugee
​
refugee_file_number
string
default:"RF123456"
required
refugee_file_number value required by this database service.Example: RF123456
​
phone_number
string
default:"+15550101000"
phone_number value required by this database service.Example: +15550101000
​
email
string
default:"john.doe@example.com"
Email address.Example: john.doe@example.com
​
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

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=ZAF" \
  -F "services=zaf_refugee" \
  -F "vendor_data=user-1234" \
  -F "refugee_file_number=RF123456"

Every successful call returns HTTP 200. The outcome_code field tells you what actually happened — distinguishing, for example, a real biometric mismatch (BIOMETRIC_NO_MATCH) from a selfie that could not be read (BIOMETRIC_IMAGE_UNUSABLE). The status shown is the default feature status; your configured Partial Match / No Match actions can override it.

​
Returned data

The exact fields surfaced in source_data depend on what the registry returns. The generated example for zaf_refugee currently documents this normalized shape:
  • Varies by registry response.

​
Pricing & SLAs

South Africa - Refugee File Verification 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