Pular para o conteúdo principal
POST
Consulta a árvore de relacionamentos

Autorizações

x-api-key
string
header
obrigatório

Corpo

application/json
document
string
obrigatório

CPF ou CNPJ do titular, com ou sem máscara. Separadores (incluindo a barra do CNPJ) são aceitos e ignorados. O dígito verificador é validado antes da consulta. O formato do resultado depende do documento: CPF devolve personal_data, CNPJ devolve company_data.

Exemplo:

"52998224725"

Resposta

O formato depende do documento consultado: CPF devolve personal_data (o exemplo abaixo), CNPJ devolve company_data, com outro conjunto de campos — nunca os dois, e nunca nenhum (sem dado é erro). Datas vêm em DD/MM/AAAA, não em ISO. Pontos de atenção, todos confirmados em captura real: (1) em business_partners/companies, relationship_end_date pode ser a string Atual no lugar de uma data, quando o vínculo está vigente, e relationship_type vem cru do fornecedor, em inglês (ex.: OWNER); (2) addresses[].address costuma começar com a string literal "null " — o campo junta tipo de logradouro + endereço, e o tipo falta na maioria dos cadastros (na captura, oito de dez endereços); limpe o prefixo antes de exibir; (3) addresses[].zipcode vem number em alguns itens e string em outros, no mesmo array; (4) relatives só traz dez tipos de parentesco, já traduzidos para pt-BR (MÃE, FILHO(a)…) — o que o fornecedor manda fora dessa lista é descartado —, o document do parente pode vir vazio, e a mãe aparece duas vezes (aqui e em mother_name); (5) age vem 0 também quando não foi possível calcular a idade. No CNPJ, relationships.has_more_relationships: true significa que havia mais de 100 relacionamentos de 1º nível e as listas foram truncadas em 100, e relationship_end_date de cada vínculo é sempre null — quem indica vínculo encerrado é is_finished.

The response is of type object.