📘 Antes de começar
Dados Básicos | API de Pessoas
Antes de começar a usar os datasets do grupo de Dados Básicos, é importante compreender alguns conceitos fundamentais que orientam a interpretação correta das informações retornadas pela API. Esses conceitos — como consultas por chaves alternativas e validações embutidas — ajudam a contextualizar os dados recebidos, permitindo avaliar sua confiabilidade, relevância e atualidade.
A seguir, detalhamos os principais elementos que apoiam essa interpretação.
Consultas por chaves alternativas
Quando a consulta é realizada por uma chave diferente do CPF — como nome + data de nascimento, e-mail, ou outros identificadores disponíveis — o dataset pode retornar múltiplos candidatos, dentro do limite configurado na chamada. Cada candidato representa uma possível correspondência encontrada, permitindo ao consumidor da API avaliar qual registro se adequa melhor ao contexto da busca e seguir com etapas adicionais de verificação. Caso as chaves alternativas fornecidas sejam amplas ou correspondam a um grande número de pessoas, a API não retornará resultados. Nesses casos, é necessário adicionar mais chaves alternativas à consulta para refinar e restringir o conjunto de correspondências.
Validações embutidas
Os datasets de Dados Básicos permitem a utilização de parâmetros opcionais que podem ser utilizados para realização de validações cadastrais diretamente na chamada. Essas validações podem ocorrer de forma isolada ou combinada, permitindo confirmar diferentes atributos do indivíduo sem custo adicional, e tornando o processo de checagem mais eficiente e integrado.

