Saltar para o conteúdo principal
POST
Serviço de verificação de cidadania da DIA. A Didit disponibiliza este serviço através de POST /v3/database-validation/ para que possa validar os dados enviados contra a fonte oficial e receber resultados de correspondência normalizados.

Cobertura

  • Cobertura: > 10%
  • País: Nova Zelândia
  • ID do serviço: nzl_new_zealand_citizenship
  • Domínio de dados: Identidade
  • Categoria: Cidadania

Entradas

  • Entradas obrigatórias: first_name, last_name, date_of_birth
  • Entradas opcionais: vendor_data
  • Consentimento: Obrigatório
  • Disponibilidade no fluxo: Disponível no fluxo
  • Cobertura: > 10%
  • Preço: $1.67 por consulta bem-sucedida

Parâmetros do corpo

string
padrão:"NZL"
obrigatório
Código de país ISO 3166-1 alpha-3 para este serviço de base de dados.Exemplo: NZL
string
padrão:"nzl_new_zealand_citizenship"
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: nzl_new_zealand_citizenship
Consentimento explícito do utilizador final para este serviço.Exemplo: true
string
padrão:"John"
obrigatório
Nome próprio a validar.Exemplo: John
string
padrão:"Doe"
obrigatório
Apelido a validar.Exemplo: Doe
string
padrão:"1990-01-01"
obrigatório
Data de nascimento no formato YYYY-MM-DD.Exemplo: 1990-01-01
string
padrão:"user-1234"
A sua referência estável para este utilizador, como o ID interno do utilizador. A Didit usa-a para associar verificações autónomas 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 faturados.

Como chamar

Dados devolvidos

Os campos exatos apresentados em source_data dependem do que o registo devolve. O exemplo gerado para nzl_new_zealand_citizenship documenta atualmente esta estrutura normalizada:
  • date_of_birth
  • first_name
  • last_name

Preços e SLAs

As consultas da DIA - Cidadania da Nova Zelândia só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $1.67 USD.
  • Faturação: por consulta bem-sucedida. Não lhe é cobrado nada 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 consoante o país e o conjunto de dados.

Continuar a ler

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