Telefones

A consulta ao conjunto telefones retorna uma listagem de telefones associados à pessoa consultada, contendo detalhes como código do país, código de área, número do telefone, operadora, 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 telefones encontrados, bem como a quantidade de números 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 phones para que este conjunto de dados seja consultado, conforme o exemplo abaixo:

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

Retorno

Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.phones da resposta. Nesse caso, a listagem de telefones localizados estará disponível na matriz de objetos data.phones.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!