A consulta ao conjunto endereços de relacionamentos retorna uma listagem de endereços das entidades que estão relacionadas à pessoa consultada, contendo detalhes como tipo do logradouro, nome do logradouro, número, bairro, cidade, estado, país, CEP, tipo de endereço, registro fiscal do relacionamento, classe do relacionamento, tipo do relacionamento, coordenadas geográficas, indicador de contato principal, ordenação de prioridade de contato e datas em que o contato foi vinculado à pessoa.
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 relationships_addresses para que este conjunto de dados seja consultado, conforme o exemplo abaixo:
{
"type": "persons",
"key_type": "cpf",
"key_value": "***********",
"datasets": [ "relationships_addresses" ]
}Retorno
Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.relationships_addresses da resposta. 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.