A consulta ao conjunto relacionamentos retorna uma listagem de relacionamentos associados à pessoa consultada, contendo detalhes como nome da entidade relacionada, classe do relacionamento, nível do relacionamento, registro fiscal da entidade relacionada e datas em que o relacionamento foi vinculado à pessoa. Além disso, o retorno inclui contadores agregados com o total de relacionamentos encontrados, bem como a quantidade de parentes, vizinhos, cônjuges, colegas de trabalho, moradores da residência, sócios e colegas de aula.
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 para que este conjunto de dados seja consultado, conforme o exemplo abaixo:
{
"type": "persons",
"key_type": "cpf",
"key_value": "***********",
"datasets": [ "relationships" ]
}Retorno
Caso a consulta seja concluída com sucesso, os dados estarão disponíveis no objeto data.relationships da resposta. Nesse caso, a listagem de relacionamentos localizados estará disponível na matriz de objetos data.relationships.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.