Consulta de administradores de empresas na África do Sul

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"
      }
    }
  ]
}

Devolve os administradores atuais de uma empresa sul-africana, a partir do registo de empresas da CIPC. A Didit disponibiliza este serviço através de POST /v3/database-validation/, para que possa verificar os dados enviados face à fonte oficial e receber resultados de correspondência normalizados.

Cobertura

Cobertura: —
País: África do Sul
ID do serviço: zaf_company_directors
Domínio de dados: Governo
Categoria: CompanyRegister

Entradas

Campo	Obrigatório	Exemplo
`company_registration_number`	Sim	`REG-123456`
`vendor_data`	Não	`user-1234`

Entradas obrigatórias: company_registration_number
Entradas opcionais: vendor_data
Consentimento: Não é necessário
Disponibilidade no fluxo: Disponível num fluxo com mapeamento de campos
Cobertura: —
Preço: $0.75 por consulta bem-sucedida

Num fluxo, company_registration_number não vem impresso em nenhum documento de identidade, por isso nenhum passo o produz sozinho. Recolha-o a partir de uma resposta de Questionário, de um campo extraído pelo Document AI ou de um valor que envie ao criar a sessão, e mapeie-o no passo de Validação de base de dados. Enquanto não estiver mapeado, o editor de fluxos mostra este serviço desativado e indica o campo em falta. Em execução, um campo em falta significa que a verificação é ignorada antes de qualquer consulta, por isso nunca se paga por uma base de dados que não pôde ser consultada.

Parâmetros do corpo

string

padrão:"ZAF"

obrigatório

Código de país ISO 3166-1 alpha-3 para este serviço de base de dados.Exemplo: ZAF

string

padrão:"zaf_company_directors"

obrigatório

Matriz que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados exata.Exemplo: zaf_company_directors

string

padrão:"REG-123456"

obrigatório

Valor de company_registration_number exigido por este serviço de base de dados.Exemplo: REG-123456

string

padrão:"user-1234"

A sua referência estável de utilizador para esta pessoa, como o seu ID interno de utilizador. A Didit usa-a para associar verificações independentes ao mesmo utilizador final e reduzir o ruído na deteção de duplicados.Exemplo: user-1234

Regras de entrada e notas de validação

Envie os campos indicados acima exatamente como foram recolhidos do utilizador ou do documento.
A Didit valida os campos obrigatórios antes de chamar a base de dados. Os pedidos rejeitados antes da consulta à fonte não são cobrados.

Como fazer a chamada

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 chamada bem-sucedida devolve HTTP 200. O campo outcome_code indica o que realmente aconteceu, distinguindo, por exemplo, uma verdadeira falta de correspondência biométrica (BIOMETRIC_NO_MATCH) de uma selfie que não pôde ser lida (BIOMETRIC_IMAGE_UNUSABLE). O status apresentado é o estado predefinido da funcionalidade. As suas ações de Partial Match / No Match configuradas podem substituí-lo.

MATCH: o registo confirmou a identidade e todos os campos verificados corresponderam.

{
  "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: o registo não devolveu qualquer correspondência para os dados enviados.

{
  "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"
      }
    }
  ]
}

Dados devolvidos

Os campos exatos apresentados em source_data dependem do que o registo devolver. O exemplo gerado para zaf_company_directors documenta atualmente esta estrutura normalizada:

Varia conforme a resposta do registo.

Preços e SLAs

As consultas de administradores de empresas na África do Sul só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.

Preço por chamada: $0.75 USD.
Faturação: por consulta bem-sucedida. Não é cobrado quando o registo está inacessível, quando faltam campos obrigatórios ou quando o pedido é rejeitado antes de chegar à fonte.
Latência: p95 típico < 2 s.
Disponibilidade: 99.9% por trimestre, do lado da Didit. A disponibilidade das fontes a jusante varia por país e por conjunto de dados.

Continuar a ler

Última modificação em 7 de novembro de 2026

​Cobertura

​Entradas

​Parâmetros do corpo

​Regras de entrada e notas de validação

​Como fazer a chamada

​Dados devolvidos

​Preços e SLAs

​Continuar a ler

Cobertura

Entradas

Parâmetros do corpo

Regras de entrada e notas de validação

Como fazer a chamada

Dados devolvidos

Preços e SLAs

Continuar a ler