Saltar para o conteúdo principal
POST
Devolve números de telefone, endereços de e-mail e moradas conhecidos associados a uma pessoa singular sul-africana. 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_contactability
  • Domínio de dados: Telecomunicações
  • Categoria: Telecomunicações

Entradas

  • Entradas obrigatórias: national_id
  • Entradas opcionais: vendor_data
  • Consentimento: obrigatório
  • Disponibilidade no fluxo: disponível no fluxo
  • Cobertura: —
  • Preço: $0.35 por consulta bem-sucedida

Parâmetros do corpo

string
padrão:"ZAF"
obrigatório
Código de país ISO 3166-1 alfa-3 deste serviço de base de dados.Exemplo: ZAF
string
padrão:"zaf_contactability"
obrigatório
Array 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_contactability
Consentimento explícito do utilizador final para este serviço.Exemplo: true
string
padrão:"SAMPLE-NID-12345"
obrigatório
Número de identificação nacional para este serviço.Exemplo: SAMPLE-NID-12345
string
padrão:"user-1234"
A sua referência estável de utilizador para esta pessoa, como o ID interno do utilizador. A Didit usa-a para associar verificações independentes ao mesmo utilizador final e reduzir o ruído da 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

Dados devolvidos

Os campos exatos apresentados em source_data dependem do que o registo devolve. O exemplo gerado para zaf_contactability documenta atualmente esta estrutura normalizada:
  • contact_email
  • contact_phone_numbers
  • date_of_birth
  • deceased
  • first_name
  • gender
  • identification_number
  • last_name
  • phone_history_count

Preços e SLAs

As consultas de pesquisa de contactabilidade da África do Sul só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $0.35 USD.
  • Faturação: por consulta bem-sucedida. Não é cobrada quando o registo não está acessí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 consoante o país e o conjunto de dados.

Continuar a ler

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