Pular para o conteúdo principal
POST
Verifica os dados em uma base combinada de registros eleitorais. A Didit disponibiliza este serviço por meio de POST /v3/database-validation/ para que você possa verificar os dados enviados em relação à fonte oficial e receber resultados de correspondência normalizados.

Cobertura

  • Cobertura: ~ 95%
  • País: Brasil
  • ID do serviço: bra_residential
  • Domínio de dados: Endereço
  • 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 de verificação (workflow): Disponível no fluxo
  • Cobertura: ~ 95%
  • Preço: $0.59 por consulta bem-sucedida
Nem todo documento aceito por este serviço contém o identificador usado na consulta. Quando o identificador não é extraído do documento, a verificação é registrada como não se aplica: nenhuma base de dados é consultada e você não é cobrado. Em alguns países, isso corresponde a uma parcela grande dos usuários reais. Para cobri-los, colete também o identificador a partir de uma resposta de Questionário, de um campo de extração do Document AI ou de um valor que você envia ao criar a sessão, e mapeie-o na etapa de 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 contendo o ID deste serviço. Fixar o serviço mantém a requisição restrita exatamente a esta base de dados.Exemplo: bra_residential
string
padrão:"John"
obrigatório
Nome a ser validado.Exemplo: John
string
padrão:"Doe"
obrigatório
Sobrenome a ser validado.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 estruturado de endereço residencial. Use street_1, street_2, city, region, postal_code e country. Uma string de endereço completa no formato legado ainda é aceita, 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 ou tributária.Exemplo: 11111111111
string
padrão:"user-1234"
Sua referência estável de usuário para esta pessoa, como o seu ID interno de usuário. A Didit a utiliza para vincular verificações avulsas ao mesmo usuário final e reduzir o ruído na detecção de duplicidades.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 pontuação antes de enviar a requisição.
  • tax_number deve ter exatamente 11 caracteres.
  • Para serviços de endereço, envie campos de endereço estruturados em vez de uma única string address sempre que possível.
  • address.street_1 é o logradouro, incluindo o número e o tipo de via.
  • address.street_2 é o apartamento, unidade, edifício, andar ou linha adicional do endereço. Envie-o somente quando você o tiver.
  • address.city é a cidade, subúrbio, distrito, localidade ou bairro.
  • address.region é o estado, província, região ou município.
  • address.postal_code é o CEP ou código postal.
  • Serviços de base de dados baseados em endereço exigem pelo menos o logradouro e o código postal; requisições rejeitadas antes da consulta à fonte não são cobradas.

Como chamar

Dados retornados

Os campos exatos exibidos em source_data dependem do que o registro retorna. O exemplo gerado para bra_residential documenta atualmente este formato normalizado:
  • address
  • date_of_birth
  • first_name
  • identification_number
  • last_name

Preços e SLAs

As consultas Brazil Residential são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $0.59 USD.
  • Faturamento: por consulta bem-sucedida. Você não é cobrado quando o cadastro está inacessível, quando faltam campos obrigatórios ou quando a requisição é rejeitada antes de chegar à fonte.
  • Latência: p95 típico < 2 s.
  • Disponibilidade: 99.9% por trimestre do lado da Didit; a disponibilidade da fonte externa varia conforme o país e o conjunto de dados.

Continue a leitura

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