Pular para o conteúdo principal
POST
Serviço agregado de dados de cabeçalho de crédito (credit header) e outros serviços. 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: ~ 90%
  • País: Estados Unidos
  • ID do serviço: usa_states_credit_bureau
  • Domínio de dados: Financeiro
  • Categoria: CreditBureau

Entradas

  • Entradas obrigatórias: first_name, last_name
  • Entradas opcionais: date_of_birth, address.street_1, address.street_2, address.city, address.region, address.postal_code, phone, ssn, email, vendor_data
  • Consentimento: Não obrigatório
  • Disponibilidade no fluxo de verificação (workflow): Disponível no fluxo
  • Cobertura: ~ 90%
  • Preço: $0.25 por consulta bem-sucedida

Parâmetros do corpo

string
padrão:"USA"
obrigatório
Código de país ISO 3166-1 alfa-3 deste serviço de banco de dados.Exemplo: USA
string
padrão:"usa_states_credit_bureau"
obrigatório
Array contendo o ID deste serviço. Fixar o serviço mantém a requisição restrita exatamente a este banco de dados.Exemplo: usa_states_credit_bureau
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"
Data de nascimento no formato YYYY-MM-DD.Exemplo: 1990-01-01
object
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
Número de telefone em formato internacional.Exemplo: +15550101000
string
Valor de ssn exigido por este serviço de banco de dados.Exemplo: 123456789
string
Endereço de e-mail.Exemplo: john.doe@example.com
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 usa para vincular verificações avulsas ao mesmo usuário final e reduzir o ruído na detecção de duplicatas.Exemplo: user-1234

Regras de entrada e observações de validação

  • address é opcional para este serviço. Você pode enviar uma única string address completa, e a Didit a dividirá em elementos de endereço estruturados quando possível, ou pode enviar os campos estruturados explicitamente.
  • Social Security Number (SSN) ou ITIN dos EUA: os 9 dígitos completos (hifens opcionais) ou apenas os 4 últimos dígitos
  • ssn deve corresponder a (?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4}).
  • Para ssn, envie o SSN/ITIN completo de 9 dígitos (hifens opcionais) ou apenas os seus 4 últimos dígitos.
  • Além dos campos obrigatórios first_name e last_name, inclua pelo menos mais um campo entre date_of_birth, address, phone, ssn ou email. Uma requisição apenas com o nome é rejeitada antes da consulta ao provedor (e não é cobrada); date_of_birth oferece a correspondência mais confiável.
  • 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 de endereço adicional. Envie-o somente se você tiver essa informação.
  • 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 código postal ou CEP.
  • Serviços de banco 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 fazer a chamada

Dados retornados

Os campos exatos exibidos em source_data dependem do que o cadastro retorna. O exemplo gerado para usa_states_credit_bureau documenta atualmente este formato normalizado:
  • address
  • address_match_score
  • city
  • date_of_birth
  • first_name
  • full_name
  • last_name
  • name_match_score
  • postal_code
  • state
  • street

Preços e SLAs

As consultas ao United States Credit Bureau (Estados Unidos da América) são cobradas somente quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $0.25 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