Saltar para o conteúdo principal
POST
Verifica os dados face a dados de recenseamento provenientes de uma agência governamental. 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: ~ 85%
  • País: França
  • ID do serviço: fra_residential
  • Domínio de dados: Morada
  • Categoria: Residencial

Entradas

  • Entradas obrigatórias: first_name, last_name, date_of_birth, address.street_1, address.postal_code
  • Entradas opcionais: address.street_2, address.city, address.region, vendor_data
  • Consentimento: Não é necessário
  • Disponibilidade no fluxo: Disponível no fluxo
  • Cobertura: ~ 85%
  • Preço: $1.49 por consulta bem-sucedida

Parâmetros do corpo

string
padrão:"FRA"
obrigatório
Código de país ISO 3166-1 alpha-3 para este serviço de base de dados.Exemplo: FRA
string
padrão:"fra_residential"
obrigatório
Lista que contém o ID deste serviço. Fixar o serviço mantém o pedido limitado a esta base de dados exata.Exemplo: fra_residential
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
object
obrigatório
Objeto de morada residencial estruturado. Use street_1, street_2, city, region, postal_code e country. Ainda é aceite uma cadeia de morada completa no formato antigo, mas não é recomendada.Exemplo: {"street_1":"123 Sample Street","street_2":"Unit 4","city":"Sample City","region":"Sample State","postal_code":"10001","country":"US"}
string
padrão:"user-1234"
A sua referência estável de utilizador para esta pessoa, como o seu ID de utilizador interno. 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

  • Para serviços de morada, envie os campos de morada estruturados em vez de uma única cadeia address, sempre que possível.
  • address.street_1 é a morada, incluindo o número da porta e o tipo de via.
  • address.street_2 é o apartamento, a fração, o edifício, o andar ou outra linha de morada adicional. Envie-o apenas quando o tiver.
  • address.city é a cidade, o subúrbio, o distrito, a localidade ou o bairro.
  • address.region é o estado, a província, a região ou a vila.
  • address.postal_code é o código postal.
  • Os serviços de base de dados baseados em morada exigem, no mínimo, a morada de rua e o código postal. Os pedidos rejeitados antes da consulta à fonte não são cobrados.

Como chamar

Dados devolvidos

Os campos exatos apresentados em source_data dependem do que o registo devolve. O exemplo gerado para fra_residential documenta atualmente esta estrutura normalizada:
  • address
  • address_match_score
  • city
  • date_of_birth
  • first_name
  • full_name
  • last_name
  • name_match_score
  • postal_code
  • street

Preços e SLAs

As consultas France Residential só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $1.49 USD.
  • Faturação: por consulta bem-sucedida. Não é cobrado 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