E-mails

A consulta ao conjunto e-mails retorna uma listagem de e-mails associados à pessoa consultada, contendo detalhes como endereço do e-mail, domínio do e-mail, nome de usuário do e-mail, tipo de e-mail, indicador de contato principal, ordenação de prioridade de contato e datas em que o contato foi vinculado à pessoa. Além disso, o retorno inclui contadores agregados com o total de e-mails encontrados, bem como a quantidade de e-mails pessoais e profissionais.

Requisição

No corpo da requisição, o campo type deve conter obrigatoriamente o valor persons e datasets deve conter uma matriz que inclua o elemento emails para que este conjunto de dados seja consultado, conforme o exemplo abaixo:

{
	"type": "persons",
	"key_type": "cpf",
	"key_value": "***********",
	"datasets": [ "emails" ]
}

Retorno

Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.emails da resposta. Nesse caso, a listagem de e-mails localizados estará disponível na matriz de objetos data.emails.items. Para saber mais sobre cada campo retornado nesta consulta, verifique a especificação do retorno de código 200 contida na seção responses abaixo.

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!