Busca avançada
Pessoa física
Busca avançada
Busque pessoas físicas por nome, filiação, documentos auxiliares ou CEP.
POST
Busca avançada
Executa uma busca avançada de pessoa física em formato paginado.
Use esta rota quando você não possui o CPF da pessoa, mas possui dados como nome completo, nome completo da mãe, nome completo do pai, RG, PIS, título de eleitor ou CEP.
Estrutura de
Estrutura de
Corpo da requisição
Nome completo da pessoa. Quando informado, deve conter ao menos nome e sobrenome.
Nome completo da mãe. Pode ser usado sem informar o nome da pessoa.
Nome completo do pai. Pode ser usado sem informar o nome da pessoa.
Número do RG. Pontuação é aceita e removida automaticamente.
Número do PIS. Pontuação é aceita e removida automaticamente.
Número do título de eleitor. Pontuação é aceita e removida automaticamente.
CEP com 8 dígitos. Pontuação é aceita e removida automaticamente.
Página dos resultados. Use a próxima página enquanto
has_more for true.Use
sandbox para executar uma chamada de teste sem consumo de saldo.Para detalhes sobre chamadas de teste, consulte
/quickstart/sandbox.Regras dos filtros
É necessário informar pelo menos um dos campos aceitos. Nomes informados emname, mother_name e father_name devem ser completos. A busca normaliza os nomes internamente para letras maiúsculas, remove acentos e padroniza espaços antes de consultar o índice.
Campos numéricos como identity_card, pis, voter_registration e zipcode aceitam pontuação, mas são consultados apenas com dígitos.
Exemplo de corpo
Resposta
Código da resposta da API.
Mensagem descritiva da resposta.
Objeto principal com os registros encontrados, dados de paginação, cobrança e tempo de execução.
Estrutura de result
| Campo | Tipo | Descrição |
|---|---|---|
items | array<object> | Registros encontrados para os filtros enviados. |
has_more | boolean | Indica se existe próxima página disponível. |
page | integer | Página retornada. |
price | number | Preço da busca para a conta autenticada. |
charged | number | Valor debitado nesta chamada. Em sandbox, retorna 0. |
debit_only_if_found | boolean | Indica se a cobrança ocorre apenas quando houver resultado útil. |
time | number | Tempo de execução em segundos. |
test | boolean | Indica se a chamada foi executada em ambiente de teste. |
Estrutura de result.items[]
| Campo | Tipo | Descrição |
|---|---|---|
taxid | string | CPF encontrado. |
name | string | Nome da pessoa. |
birthdate | string | Data de nascimento no formato yyyy-mm-dd, quando disponível. |
age | integer | Idade calculada, quando disponível. |
mother_name | string | Nome da mãe, quando disponível. |
father_name | string | Nome do pai, quando disponível. |
location | string | Localização resumida, quando disponível. |
city | string | Cidade, quando disponível. |
state | string | UF, quando disponível. |
synthetic | boolean | Indica retorno sintético em chamadas sandbox, quando aplicável. |
Paginação
Quandohas_more retornar true, envie a mesma requisição incrementando page.
Respostas esperadas
As respostas possíveis estão exemplificadas no painel lateral da página.| Status | Quando ocorre |
|---|---|
200 | Busca executada com sucesso. |
400 | Requisição inválida, filtro ausente ou campo em formato incompatível. |
401 | A chave da API está ausente, inválida ou não pôde ser autenticada. |
403 | A credencial não possui escopo de consulta, o plano não permite acesso ou há bloqueio financeiro. |
Fluxo recomendado
- Envie os filtros mais específicos disponíveis.
- Use nomes completos para reduzir ambiguidades.
- Leia
itemse verifiquehas_more. - Se
has_morefortrue, consulte a próxima página. - Use
x-ambient: sandboxpara validar integração sem consumir saldo.

