Saltar para o conteúdo principal
POST
Serviço agregado de dados de cabeçalho de crédito e outros serviços. A Didit disponibiliza este serviço através de POST /v3/database-validation/, para que possa validar os dados submetidos contra a 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 é necessário
  • Disponibilidade no fluxo: 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 para este serviço de base de dados.Exemplo: USA
string
padrão:"usa_states_credit_bureau"
obrigatório
Array que contém este ID de serviço. Fixar o serviço mantém o pedido limitado a esta base de dados exata.Exemplo: usa_states_credit_bureau
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"
Data de nascimento no formato YYYY-MM-DD.Exemplo: 1990-01-01
object
Objeto de morada residencial estruturado. Use street_1, street_2, city, region, postal_code e country. Ainda é aceite uma morada legada completa em formato de string, 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 base de dados.Exemplo: 123456789
string
Endereço de e-mail.Exemplo: john.doe@example.com
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 da deteção de duplicados.Exemplo: user-1234

Regras de entrada e notas de validação

  • O campo address é opcional para este serviço. Pode enviar uma morada completa no campo address, numa única string, e a Didit irá separá-la em elementos de morada estruturados sempre que possível, ou pode enviar os campos estruturados explicitamente.
  • Número de Segurança Social dos EUA ou ITIN - 9 dígitos completos (traços opcionais) ou apenas os últimos 4 dígitos
  • ssn tem de corresponder a (?:\d{9}|\d{3}-\d{2}-\d{4}|\d{4}).
  • Para ssn, envie o SSN/ITIN completo de 9 dígitos (traços opcionais) ou apenas os seus últimos 4 dígitos.
  • Para além de first_name e last_name, obrigatórios, inclua pelo menos mais um campo entre date_of_birth, address, phone, ssn ou email. Um pedido apenas com o nome é rejeitado antes da consulta ao fornecedor (e não é cobrado). A date_of_birth proporciona a correspondência mais fiável.
  • Nos serviços de morada, envie campos de morada estruturados em vez de uma única string address sempre que possível.
  • address.street_1 é a morada da rua, incluindo o número de 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 localidade.
  • address.postal_code é o código postal.
  • Os serviços de base de dados baseados em morada 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 devolve. O exemplo gerado para usa_states_credit_bureau documenta atualmente esta estrutura normalizada:
  • 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 dos Estados Unidos da América são faturadas apenas quando a Didit recebe um resultado conclusivo da fonte de validação.
  • Preço por chamada: $0.25 USD.
  • Faturação: por consulta bem-sucedida. Não lhe é 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 leitura

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