Consulta de directors d'empreses a Sud-àfrica - API

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

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_company_directors",
      "service_name": "South Africa - Company Directors Lookup",
      "source_data": {},
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}

{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_company_directors",
      "service_name": "South Africa - Company Directors Lookup",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}

POST

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_company_directors" \
  -F "vendor_data=user-1234" \
  -F "company_registration_number=REG-123456"

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_company_directors",
      "service_name": "South Africa - Company Directors Lookup",
      "source_data": {},
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}

{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_company_directors",
      "service_name": "South Africa - Company Directors Lookup",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}

Retorna els directors actuals d’una empresa sud-africana del registre mercantil de la CIPC. Didit ofereix aquest servei a través de POST /v3/database-validation/ perquè puguis verificar les dades enviades amb la font oficial i rebre resultats de coincidència normalitzats.

Cobertura

Cobertura: —
País: Sud-àfrica
ID del servei: zaf_company_directors
Àmbit de dades: Govern
Categoria: CompanyRegister

Entrades

Camp	Obligatori	Exemple
`company_registration_number`	Sí	`REG-123456`
`vendor_data`	No	`user-1234`

Entrades obligatòries: company_registration_number
Entrades opcionals: vendor_data
Consentiment: No cal
Disponibilitat al flux de treball: Disponible al flux de treball amb mapatge de camps
Cobertura: —
Preu: $0.75 per consulta satisfactòria

En un flux de treball, company_registration_number no apareix imprès en cap document d’identitat, així que cap pas no el produeix per si sol. Recopila’l d’una resposta del qüestionari, d’un camp extret amb Document AI o d’un valor que enviïs en crear la sessió, i mapa’l al pas de Validació en bases de dades. Mentre no estigui mapat, l’editor de fluxos de treball mostra aquest servei desactivat i indica l’entrada que falta. En execució, una entrada que falta fa que la comprovació s’ometi abans de fer cap consulta, així que mai no et facturen una base de dades que no s’ha pogut consultar.

Paràmetres del cos

string

predeterminat:"ZAF"

requerit

Codi de país ISO 3166-1 alpha-3 per a aquest servei de base de dades.Exemple: ZAF

string

predeterminat:"zaf_company_directors"

requerit

Matriu que conté l’ID d’aquest servei. Fixar el servei manté la sol·licitud limitada a aquesta base de dades exacta.Exemple: zaf_company_directors

string

predeterminat:"REG-123456"

requerit

Valor de company_registration_number que requereix aquest servei de base de dades.Exemple: REG-123456

string

predeterminat:"user-1234"

La teva referència d’usuari estable per a aquesta persona, com ara el teu ID d’usuari intern. Didit l’utilitza per vincular les comprovacions independents al mateix usuari final i reduir el soroll de detecció de duplicats.Exemple: user-1234

Regles d’entrada i notes de validació

Envia els camps indicats anteriorment exactament tal com s’han capturat de l’usuari o del document.
Didit valida els camps obligatoris abans de cridar la base de dades. Les sol·licituds rebutjades abans de consultar la font no es cobren.

Com cridar-lo

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

Cada crida satisfactòria retorna HTTP 200. El camp outcome_code indica què ha passat realment, i distingeix, per exemple, una discrepància biomètrica real (BIOMETRIC_NO_MATCH) d’una selfie que no s’ha pogut llegir (BIOMETRIC_IMAGE_UNUSABLE). L’status que es mostra és l’estat predeterminat de la funcionalitat; les accions configurades per a Coincidència parcial / Cap coincidència poden substituir-lo.

MATCH: El registre ha confirmat la identitat i tots els camps comprovats coincideixen.

{
  "request_id": "req_01H…",
  "status": "Approved",
  "issuing_state": "ZAF",
  "match_type": "full_match",
  "validations": [
    {
      "outcome_code": "MATCH",
      "service_id": "zaf_company_directors",
      "service_name": "South Africa - Company Directors Lookup",
      "source_data": {},
      "validation": {
        "identification_number": "full_match"
      }
    }
  ]
}

NO_MATCH: El registre no ha retornat cap coincidència per a les dades enviades.

{
  "request_id": "req_01H…",
  "status": "Declined",
  "issuing_state": "ZAF",
  "match_type": "no_match",
  "validations": [
    {
      "outcome_code": "NO_MATCH",
      "service_id": "zaf_company_directors",
      "service_name": "South Africa - Company Directors Lookup",
      "source_data": {
        "identification_number": "NO_MATCH"
      },
      "validation": {
        "identification_number": "no_match"
      }
    }
  ]
}

Dades retornades

Els camps exactes que apareixen a source_data depenen del que retorni el registre. L’exemple generat per a zaf_company_directors documenta actualment aquesta estructura normalitzada:

Varia segons la resposta del registre.

Preus i SLA

Les consultes de directors d’empreses de Sud-àfrica només es facturen quan Didit rep un resultat concloent de la font de validació.

Preu per crida: $0.75 USD.
Facturació: per consulta satisfactòria. No et facturen quan el registre no és accessible, quan falten camps obligatoris o quan la sol·licitud es rebutja abans d’arribar a la font.
Latència: p95 típic inferior a 2 s.
Disponibilitat: 99.9% per trimestre per part de Didit; la disponibilitat de la font posterior varia segons el país i el conjunt de dades.

Continua llegint

Darrera modificació el 7 de novembre del 2026

​Cobertura

​Entrades

​Paràmetres del cos

​Regles d’entrada i notes de validació

​Com cridar-lo

​Dades retornades

​Preus i SLA

​Continua llegint

Cobertura

Entrades

Paràmetres del cos

Regles d’entrada i notes de validació

Com cridar-lo

Dades retornades

Preus i SLA

Continua llegint