API Reference4. Cadastral Pessoa Física4.1 Consulta e Enriquecimento PF

PF Email

Esta API retorna os dados básicos de pessoas físicas associadas a um endereço de e-mail. A resposta fornece registros com nome completo ou razão social, cidade e UF. Essa consulta permite validar ou enriquecer dados com base em informações de e-mail para fins de identificação, segmentação e análise. <Note> Indicada para identificação de titulares a partir de um endereço de e-mail, validação cadastral e enriquecimento de dados em fluxos de compliance e cobrança. </Note> ## TABELA DE CAMPOS DE REQUISIÇÃO | **Campo** | **Descrição** | **Formato** | **Obrigatório** | |-----------|---------------|-------------|-----------------| | **IdConsulta** | Identificador da consulta. Valor fixo: `357`. | string | Sim | | **Email** | E-mail a ser consultado. | string | Sim | | **TipoPessoa** | Tipo de pessoa consultada. Valor fixo: `F`. | string | Sim | ## TABELA DE CAMPOS DE RETORNO <AccordionGroup> <Accordion title="Cabeçalho da Resposta — CONSULTA"> | **Campo** | **Descrição** | **Formato** | |:----------|:--------------|:------------| | **CONSULTA.CODIGORESPOSTA** | Código interno da transação. | string | | **CONSULTA.DATAHORA** | Data e hora da consulta. | `DD/MM/YYYY HH:MM:SS` | | **CONSULTA.LOGON** | Identificador da conta que realizou a consulta. | string | | **CONSULTA.IDCONSULTA** | IdConsulta enviado na requisição. | string | </Accordion> <Accordion title="✉️ Busca por E-mail — EMAILS"> | **Campo** | **Descrição** | **Formato** | |:----------|:--------------|:------------| | **RESPOSTA.CODIGO** | Código do resultado: `1` sucesso · `2` não encontrado · `3` erro. | string | | **RESPOSTA.EMAILS.REGISTRO_N.TIPOPESSOA** | Tipo de pessoa do titular do e-mail (`PF` ou `PJ`). | string | | **RESPOSTA.EMAILS.REGISTRO_N.CPFCNPJ** | CPF/CNPJ do titular do e-mail. | string | | **RESPOSTA.EMAILS.REGISTRO_N.NOMERAZAO** | Nome ou razão social do titular do e-mail. | string | | **RESPOSTA.EMAILS.REGISTRO_N.CIDADE** | Cidade associada ao titular. | string | | **RESPOSTA.EMAILS.REGISTRO_N.UF** | UF associada ao titular. | string | </Accordion> </AccordionGroup>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Objeto de consulta com o e-mail a ser pesquisado.

ConsultaobjectRequired

Response

Resposta da consulta: * Código `1`: Sucesso. * Código `2`: Dado não encontrado na base de dados. * Código `3`: Erro na consulta.

Errors

400
Bad Request Error
401
Unauthorized Error