Saltar para o conteúdo principal
POST
Verifica contra uma base de dados combinada de registos eleitorais. A Didit disponibiliza este serviço através de POST /v3/database-validation/, para que possa verificar os dados enviados contra a fonte oficial e receber resultados de correspondência normalizados. Formato de entrada: tax_number aceita o CPF brasileiro (exatamente 11 dígitos).

Cobertura

  • Cobertura: ~ 95%
  • País: Brasil
  • ID do serviço: bra_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, tax_number
  • Entradas opcionais: address.street_2, address.city, address.region, vendor_data
  • Consentimento: não obrigatório
  • Disponibilidade no fluxo: disponível no fluxo
  • Cobertura: ~ 95%
  • Preço: $0.59 por consulta bem-sucedida
Nem todos os documentos aceites por este serviço contêm o identificador que utiliza na consulta. Quando o identificador não é extraído do documento, a verificação é registada como não aplicável: nenhuma base de dados é consultada e não é cobrado qualquer valor. Em alguns países, isto representa uma grande parte dos utilizadores reais. Para os cobrir, recolha também o identificador a partir de uma resposta de um questionário, de um campo de extração do Document AI ou de um valor que envie ao criar a sessão, e mapeie-o no passo Validação de base de dados.

Parâmetros do corpo

string
padrão:"BRA"
obrigatório
Código de país ISO 3166-1 alfa-3 deste serviço de base de dados.Exemplo: BRA
string
padrão:"bra_residential"
obrigatório
Array que contém o ID deste serviço. Fixar o serviço mantém o pedido restrito a esta base de dados exata.Exemplo: bra_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. Utilize street_1, street_2, city, region, postal_code e country. Uma morada legada completa, sob a forma de cadeia de caracteres, continua a ser aceite, 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:"11111111111"
obrigatório
Número de identificação fiscal.Exemplo: 11111111111
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

  • CPF brasileiro (exatamente 11 dígitos)
  • tax_number deve conter apenas dígitos; remova espaços, hífens e sinais de pontuação antes de enviar o pedido.
  • tax_number deve ter exatamente 11 caracteres.
  • Nos serviços baseados em moradas, envie campos de morada estruturados em vez de uma única cadeia address, sempre que possível.
  • address.street_1 é a morada da rua, incluindo o número de polícia e o tipo de via.
  • address.street_2 é o apartamento, a fração, o edifício, o piso ou outra linha adicional da morada. Envie-o apenas quando o tiver.
  • address.city é a cidade, a zona suburbana, 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 moradas exigem, no mínimo, a morada da 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 devolver. O exemplo gerado para bra_residential documenta atualmente esta estrutura normalizada:
  • address
  • date_of_birth
  • first_name
  • identification_number
  • last_name

Preços e SLAs

As consultas Brazil Residential só são faturadas quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $0.59 USD.
  • Faturação: por consulta bem-sucedida. Não lhe é cobrado qualquer valor 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 por parte da Didit; a disponibilidade das fontes a jusante varia consoante o país e o conjunto de dados.

Continue a ler

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