Skip to main content
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.

Corpo da requisição

string
Nome completo da pessoa. Quando informado, deve conter ao menos nome e sobrenome.
string
Nome completo da mãe. Pode ser usado sem informar o nome da pessoa.
string
Nome completo do pai. Pode ser usado sem informar o nome da pessoa.
string
Número do RG. Pontuação é aceita e removida automaticamente.
string
Número do PIS. Pontuação é aceita e removida automaticamente.
string
Número do título de eleitor. Pontuação é aceita e removida automaticamente.
string
CEP com 8 dígitos. Pontuação é aceita e removida automaticamente.
integer
default:"1"
Página dos resultados. Use a próxima página enquanto has_more for true.
string
Use sandbox para executar uma chamada de teste sem consumo de saldo.
Para detalhes sobre chamadas de teste, consulte Ambiente de teste.

Regras dos filtros

É necessário informar pelo menos um dos campos aceitos. Nomes informados em name, 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

integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
required
Objeto principal com os registros encontrados, dados de paginação, cobrança e tempo de execução.

Estrutura de result

Estrutura de result.items[]

Campos de items[] podem não ser retornados em todas as consultas. A disponibilidade depende dos filtros enviados, do índice consultado e dos dados existentes para o registro encontrado.

Paginação

Quando has_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.

Fluxo recomendado

  1. Envie os filtros mais específicos disponíveis.
  2. Use nomes completos para reduzir ambiguidades.
  3. Leia items e verifique has_more.
  4. Se has_more for true, consulte a próxima página.
  5. Use x-ambient: sandbox para validar integração sem consumir saldo.