A consulta ao conjunto endereços retorna uma listagem de endereços associados à empresa consultada, contendo detalhes como tipo do logradouro, nome do logradouro, número, bairro, cidade, estado, país, CEP, tipo de endereço, coordenadas geográficas, indicador de contato principal, ordenação de prioridade de contato e datas em que o contato foi vinculado à empresa. Além disso, o retorno inclui contadores agregados com o total de endereços encontrados, bem como a quantidade de endereços pessoais e profissionais.
Requisição
No corpo da requisição, o campo type deve conter obrigatoriamente o valor companies e datasets deve conter uma matriz que inclua o elemento addresses para que este conjunto de dados seja consultado, conforme o exemplo abaixo:
{
"type": "companies",
"key_type": "cnpj",
"key_value": "**************",
"datasets": [ "addresses" ]
}Retorno
Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.addresses da resposta. Nesse caso, a listagem de endereços localizados estará disponível na matriz de objetos data.addresses.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.