Relacionamentos

A consulta ao conjunto relacionamentos retorna uma listagem de relacionamentos associados à empresa consultada, contendo detalhes como nome da entidade relacionada, classe do relacionamento, tipo do relacionamento, nível do relacionamento, origem da informação sobre o relacionamento, registro fiscal da entidade relacionada e datas em que o relacionamento foi vinculado à empresa. Além disso, o retorno inclui contadores agregados com o total de relacionamentos encontrados, bem como a quantidade de sócios, empregados, participações em outras empresas, clientes e fornecedores.

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 relationships para que este conjunto de dados seja consultado, conforme o exemplo abaixo:

{
	"type": "companies",
	"key_type": "cnpj",
	"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.

Body Params
string
enum
required

Tipo da busca

Allowed:
string
enum
required

Tipo da chave de busca

Allowed:
string
required

Valor da chave de busca

datasets
array of strings
enum
required

Lista de conjuntos de dados desejados

datasets*
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json