E-mails
E-mails vinculados a um CPF, com tipo (pessoal ou profissional), status de validação e prioridade.
Quando usar
Atualização cadastral
Recupere e-mails válidos para clientes com cadastro antigo.
Localização de devedor
Mais um canal de contato para cobranças existentes.
Como funciona
Fluxo assíncrono
- 1POSTCriar consulta
Envia o documento e recebe o requestId na hora.
- 2GETAcompanhar
Repete a chamada com o requestId enquanto o status for pending.
- 3GETBuscar resultado
Com status done, o resultado completo vem em data.
Como acompanhar o resultado
Repita o GET a cada 2 ou 3 segundos até o status ser done ou error. A maioria das consultas termina em poucos segundos.
Passo 1
Criar consulta
/api/partner/v2/people/emailsCriar consulta de e-mails (CPF).
Corpo da requisição
documentstringobrigatórioCPF com 11 dígitos (apenas números)
Respostas
- 200Solicitação criada com sucesso
curl -X POST "https://consultadeprocessos.com.br/api/partner/v2/people/emails" \
-H "Authorization: Bearer SUA_CHAVE_DE_API" \
-H "Content-Type: application/json" \
-d '{"document":"12345678901"}'{
"requestId": "cm8p1q2r30004ab12cdef5678",
"message": "Solicitação realizada com sucesso"
}Passo 2
Buscar resultado
/api/partner/v2/people/emails/{requestId}Consultar resultado de e-mails (CPF).
Parâmetros do caminho
requestIdstringno caminhoobrigatório
Respostas
- 200Resultado da solicitação
curl -X GET "https://consultadeprocessos.com.br/api/partner/v2/people/emails/cm8p1q2r30004ab12cdef5678" \
-H "Authorization: Bearer SUA_CHAVE_DE_API"{
"data": {
"document": "12345678901",
"totalEmails": 2,
"totalActiveEmails": 2,
"totalWorkEmails": 1,
"totalPersonalEmails": 1,
"totalUniqueEmails": 2,
"emails": [
{
"id": "cm8p1q2r30004ab12cdef5678",
"emailAddress": "maria.silva@exemplo.com.br",
"domain": "exemplo.com.br",
"userName": "maria.silva",
"type": "personal",
"priority": 1,
"isMainForEntity": true,
"isRecentForEntity": true,
"isActive": true,
"validationStatus": "VALID",
"lastValidationDate": "2026-08-14T00:00:00.000Z"
}
]
},
"status": "done"
}O que a resposta traz
Resumo
- Totais de e-mails, ativos, profissionais e pessoais
totalEmails · totalActiveEmails · totalWorkEmails · totalPersonalEmails
E-mails
- Endereço, domínio e usuário
emails[].emailAddress · domain · userName - Tipo e prioridade
type · priorityQuanto menor a prioridade, mais relevante o e-mail.
- Principal ou recente para o titular
isMainForEntity · isRecentForEntity - Situação e validação
isActive · validationStatus · lastValidationDate
Valores por plano
| Plano mensal | Valor da consulta |
|---|---|
Sob demanda | Indisponível |
O valor é cobrado por consulta, na criação da consulta. Ler o resultado de novo pelo mesmo requestId não gera nova cobrança.
Sem plano, a conta usa o valor Sob demanda e paga só o que consumir.
Comparar planosPróximos passos
Autenticação
Gere a chave e envie no cabeçalho.
Erros e códigos
Como tratar cada resposta de erro.
Cobrança e reembolso
Quando cobramos e quando o valor volta.
Dados cadastrais CPF
Nome, data de nascimento, filiação e situação cadastral de uma pessoa pelo CPF.
Dados cadastrais CNPJ
Razão social, situação cadastral, CNAE, natureza jurídica e capital social de uma empresa pelo CNPJ.
Telefones
Telefones vinculados a um CPF, com tipo, operadora e indicação de qual é o principal.