Busca por e-mail
Pessoa física
Busca por e-mail
Busque pessoas físicas vinculadas a um endereço de e-mail.
POST
Busca por e-mail
Executa uma busca paginada de pessoa física a partir de um endereço de e-mail.
Use esta rota quando você possui um e-mail e precisa localizar possíveis pessoas físicas relacionadas a ele.
Estrutura de
Estrutura de
Corpo da requisição
E-mail usado na busca. O valor é normalizado para letras minúsculas antes da consulta.
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 do e-mail
O campoemail deve conter um endereço de e-mail válido.
Espaços no início e no fim são removidos automaticamente, e o valor é convertido para letras minúsculas antes da busca.
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 o e-mail informado. |
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, e-mail ausente ou e-mail 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
- Informe um endereço de e-mail válido.
- Leia
itemse verifiquehas_more. - Se
has_morefortrue, consulte a próxima página. - Use
x-ambient: sandboxpara validar integração sem consumir saldo.

