Documentação Técnica

Relacionamentos Econômicos

Descrição

O dataset de Relacionamentos Econômicos retorna a lista de entidades relacionadas com o indivíduo consultado em um escopo econômico, o que inclui tipos de relacionamento como a participação societária em empresas, relacionamentos de emprego (para os quais os detalhes podem ser vistos no dataset de Dados Profissionais), dentre outros.

Origem da Informação

As informações de quadro societário e representação legal são extraídas a partir de dados de empresas disponibilizados publicamente pela Receita Federal do Brasil (ou órgãos equivalentes em outros países). Outros tipos de relacionamento, como o de emprego, são inferidos a partir de informações contextuais, como a utilização de um e-mail do domínio corporativo da empresa, ou a apresentação de um telefone empresarial como referência.

Tabela de preços para esse dataset

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,030
10001 - 50000R$ 0,028
50001 - 100000R$ 0,027
100001 - 500000R$ 0,026
500001 - 1000000R$ 0,025
1000001 - 5000000R$ 21.000,00 (preço fixo)
5000001 e acimaEntre em contato

Parâmetros de consulta

A tabela abaixo detalha os campos aceitos na consulta a este dataset.

CampoDescriçãoValores PossíveisTipo de Campo
docDocumento de identificaçãoCPF🛑 Obrigatório
birthdateData de Nascimentoyyyy-MM-ddℹ️  Opcional
dateformatFormato da Datayyyy-MM-dd, dd/MM/yyyyℹ️  Opcional

Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.

Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:

{  
    "Datasets": "business_relationships",
    "q": "doc{CPF}"  
}  

Filtros

CampoDescrição do filtroTipo do filtroValores Possíveis do Filtro
relationshiptypeTipo do relacionamentoIgualemployment, partner, ownership, legal representative
relationshiplevelNível do relacionamentoIgualDIRECT, SECOND-LEVEL, THIRD-LEVEL
relatedentitytaxidtypeTipo do documento relacionadoIgualCPF, CNPJ
iscurrentlyactiveFlag de relacionamento ativoIgualtrue, false

Abaixo está um exemplo de como utilizar o parâmetro .filter(nome_do_campo=XXXX)

{  
    "Datasets": "business_relationships.filter(relationshiptype=employment)",
    "q": "doc{CPF}"  
}  

Limite

Para utilizar o campo de limite basta utilizar o parâmetro .limit(x)
Para este dataset, há um limite padrão de 100 registros por chamada. Caso o retorno possua mais registros do que esse limite, retornará um campo adicional, o NextPageId, que poderá ser utilizado para paginar a consulta e obter o restante dos dados. O limite máximo que pode ser utilizado nesse dataset é de 1000 registros.

{  
    "Datasets": "business_relationships.limit(10)",
    "q": "doc{CPF}"  
}  

Paginação

A paginação do dataset pode ser feita através do parâmetro .next(x), utilizando o ID retornado pela requisição anterior e um parâmetro de consulta q com o mesmo parâmetro inserido na consulta original, conforme o exemplo abaixo:

{  
    "Datasets": "business_relationships.next(Id da próxima página)",
    "q": "doc{CPF}"  
}  

A paginação não pode ser utilizada em conjunto com o referencedate ou com o filtro de iscurrentlyactive. Não há cobrança sobre as requisições de paginação. Recomendamos utilizar a paginação com o valor padrão de 100 registros como limite.

Retorno de Representantes Legais

Este dataset fornece dados da Receita Federal sobre indivíduos que foram ou são representantes legais de menores de idade presentes no quadro societário de alguma empresa. Nesses casos, o campo RelationshipType é preenchido com o valor LEGAL REPRESENTATIVE.

Language
Credentials
Click Try It! to start a request and see the response here!