For the complete documentation index, see llms.txt. This page is also available as Markdown.

Verificação global de identidade

A consulta serve para verificar se os dados básicos de uma pessoa são consistentes. Em outras palavras, ela avalia se o nome, a data de nascimento, o endereço, o número de telefone e o número do documento realmente pertencem a essa pessoa. Por meio dessa verificação, a consulta valida o conjunto de dados fornecido e classifica a confiabilidade das informações como confiável, suficiente ou não confiável.

Para indicar a confiabilidade de um indivíduo, existem várias combinações possíveis de dados para avaliar a pontuação de confiabilidade, que pode variar entre 10, 20 ou 30.

Seção: globalIdentityVerifications

Países suportados: Argentina, Austrália*, Áustria, Bélgica, Brasil, Canadá*, China, Chile, Colômbia, Tchéquia, Dinamarca, Finlândia, França, Alemanha, Gana, Gibraltar, Grécia, Hong Kong*, Índia*, Indonésia, Irlanda, Itália, Japão, Quênia, Luxemburgo, Malásia, México, Países Baixos, Nova Zelândia, Nigéria, Noruega, Filipinas, Polônia, Portugal, Singapura, Eslováquia, África do Sul, Espanha, Suécia, Suíça, Turquia, Reino Unido, Estados Unidos e Vietnã.

Observação: Austrália, Canadá, Hong Kong e Índia exigem autorização para consulta antes de poder acessar os dados (processo de onboarding).

Atributo
Tipo
Descrição
Obrigatório

name

string

Nome completo do indivíduo.

Sim

birthDate

string

Data de nascimento do indivíduo.

Sim

address

string

Endereço do indivíduo.

Sim

phoneNumber

string

Número de telefone do indivíduo.

Sim

nationalId

string

Um número de identificação ou documento emitido pelo governo.

Sim/Não (Depende do país)

zipCode

string

CEP do endereço do indivíduo.

Sim

countryCode

string

Código do país do indivíduo.

Sim

dateFormat

string

Formato da data de nascimento.

Não

Observação: Alguns campos retornados por esta API são opcionais e sua presença não pode ser garantida.

Atributo
Tipo
Descrição

dados

objeto

Objeto contendo os dados principais.

data.detailList

string

Detalhes relacionados à consulta.

data.adaptation

string

Indicador de adaptação.

data.messages

array

Lista de mensagens que fornecem detalhes sobre o nível de correspondência de cada dado.

data.messages[].value

string

Indica o nível de correspondência dos dados (correspondência completa, sem correspondência, correspondência parcial etc.).

data.messages[].code

string

Código indicando o tipo de dado analisado (FIRSTNAME, COMPLETENAME, PHONENUMBER etc.).

data.detailCode

string

Código detalhado específico do processo ou da solicitação.

data.query

objeto

Informações sobre a consulta realizada.

data.query.options

string

Valor interno que indica o tipo de busca da consulta.

data.reliability

string

Indicador de confiabilidade (10, 20, 30).

data.statusCode

string

Status da transação. Consulte nosso guia de status.

código de status

string

Refere-se apenas ao status desta consulta, não à transação inteira. Consulte nosso guia de status

Regra
Descrição

Informação básica com correspondência confiável

Indica se as informações básicas do indivíduo (nome, endereço, data de nascimento, número do documento e número de telefone) correspondem.

Informação básica com correspondência suficiente

Indica se as informações básicas do indivíduo (nome, endereço, data de nascimento, número do documento e número de telefone) correspondem parcialmente.

Atualizado