Skip to navigation
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.

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.

TABELA DE CAMPOS DE REQUISIÇÃO

CampoDescriçãoFormatoObrigatório
IdConsultaIdentificador da consulta. Valor fixo: 357.stringSim
EmailE-mail a ser consultado.stringSim
TipoPessoaTipo de pessoa consultada. Valor fixo: F.stringSim

TABELA DE CAMPOS DE RETORNO

CampoDescriçãoFormato
CONSULTA.CODIGORESPOSTACódigo interno da transação.string
CONSULTA.DATAHORAData e hora da consulta.DD/MM/YYYY HH:MM:SS
CONSULTA.LOGONIdentificador da conta que realizou a consulta.string
CONSULTA.IDCONSULTAIdConsulta enviado na requisição.string
CampoDescriçãoFormato
RESPOSTA.CODIGOCódigo do resultado: 1 sucesso · 2 não encontrado · 3 erro.string
RESPOSTA.EMAILS.REGISTRO_N.TIPOPESSOATipo de pessoa do titular do e-mail (PF ou PJ).string
RESPOSTA.EMAILS.REGISTRO_N.CPFCNPJCPF/CNPJ do titular do e-mail.string
RESPOSTA.EMAILS.REGISTRO_N.NOMERAZAONome ou razão social do titular do e-mail.string
RESPOSTA.EMAILS.REGISTRO_N.CIDADECidade associada ao titular.string
RESPOSTA.EMAILS.REGISTRO_N.UFUF associada ao titular.string

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