Skip to main content
POST
Busca por CPF
Executa uma consulta de pessoa física por CPF usando os datasets informados no corpo da requisição. Essa consulta pode ser executada em modo síncrono ou assíncrono. No modo assíncrono, a API retorna um id para acompanhamento posterior do resultado.

Corpo da requisição

string
required
CPF da pessoa consultada. Pontuação é aceita e removida automaticamente.
string[]
required
Lista de IDs dos datasets que serão consultados.
object
Dados adicionais por dataset, quando algum dataset exigir parâmetros extras.
string
default:"async"
Modo da consulta.
Valores aceitos para mode:
string
Use sandbox para executar uma chamada de teste sem consumo de saldo.
Para detalhes sobre chamadas de teste, consulte Ambiente de teste.

Exemplo de corpo

O CPF acima é fictício e serve apenas para demonstrar a estrutura da requisição. Em chamadas reais ou sandbox, informe um CPF válido para o ambiente utilizado.

Parâmetros adicionais por dataset

Alguns datasets podem exigir campos adicionais. Consulte additional_fields no endpoint de datasets e preços para saber quais campos devem ser enviados. Exemplo de envio de dados adicionais:

Resposta

integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
required
Objeto principal da consulta. A estrutura varia de acordo com o modo de execução.

Retorno síncrono

Quando mode é sync, a resposta pode retornar code: 200 com os dados completos da consulta.

Estrutura de result

Estrutura de result.query

Estrutura de result.cost

Estrutura de result.timing

Estrutura de result.errors

O campo errors retorna um objeto indexado pelo ID do dataset quando alguma base falha. Exemplo:

Estrutura de result.datasets_status

Objeto com o status individual de cada dataset. Exemplo:

Estrutura de result.result

Objeto indexado pelo ID do dataset. Cada chave contém o retorno do dataset correspondente.
Campos descritos na estrutura do dataset podem não ser retornados em todas as consultas. Alguns dados dependem da disponibilidade da fonte e do CPF consultado.

Retorno assíncrono

Quando mode é async, a resposta inicial retorna code: 202 e o processamento continua em segundo plano.

Estrutura de result

Status possíveis: Para consultar o resultado final, use o id retornado no endpoint de resultado assíncrono.

Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.

Fluxo recomendado

  1. Liste os datasets disponíveis em Datasets e preços.
  2. Selecione apenas datasets com active: true.
  3. Envie o CPF, os datasets e os campos adicionais necessários.
  4. Use mode: "async" para consultas com múltiplos datasets ou fontes online.
  5. Consulte o resultado pelo id retornado quando a chamada for assíncrona.