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_person_directorships" \
  -F "vendor_data=user-1234" \
  -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_person_directorships",
      "service_name": "South Africa - Person Directorships Lookup",
      "source_data": {
        "directorships": "sample_value",
        "identification_number": "SAMPLE-ID-12345"
      },
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}
Returns all CIPC-registered directorships held by 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_person_directorships
  • Data domain: Government
  • Category: CompanyRegister

​
Inputs

FieldRequiredExample
national_idYesSAMPLE-NID-12345
vendor_dataNouser-1234
  • Required inputs: national_id
  • Optional inputs: vendor_data
  • Consent: Not required
  • Workflow availability: Available in workflow
  • Coverage: —
  • Price: $1.20 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_person_directorships"
required
Array containing this service ID. Pinning the service keeps the request scoped to this exact database.Example: zaf_person_directorships
​
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

curl -X POST "https://verification.didit.me/v3/database-validation/" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "issuing_state=ZAF" \
  -F "services=zaf_person_directorships" \
  -F "vendor_data=user-1234" \
  -F "national_id=SAMPLE-NID-12345"

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_person_directorships currently documents this normalized shape:
  • directorships
  • identification_number

​
Pricing & SLAs

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