Documentação Técnica

Relacionamentos Pessoais

Descrição

O dataset de Relacionamentos Pessoais retorna a lista de entidades relacionadas com o indivíduo consultado em um escopo pessoal, que inclui a família, o household, colegas de classe (pessoas que fizeram o mesmo curso na mesma faculdade na mesma época) e outros relacionamentos de cunho não-profissional. Estatísticas, contagens e uma visão agregada da totalidade das pessoas relacionadas, em diferentes níveis, podem ser vistas através dos datasets de círculos.

Origem da Informação

Todos os relacionamentos apresentados nesse dataset são resultado de um processo de inferência baseada nas informações coletadas nos processos de crawling da BigData Corp. A árvore genealógica da pessoa é estruturada a partir de informações de nome e de nome da mãe, disponibilizadas publicamente pelo governo, e outros tipos de relacionamento são mapeados a partir da utilização conjunta (no mesmo período de tempo) de informações de contato relevantes, ou a partir de outras informações contextuais disponíveis.

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

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": "related_people",
    "q": "doc{CPF}"  
}  

Filtros

CampoDescrição do filtroTipo do filtroValores Possíveis do Filtro
relatedentitytaxidtypeTipo do documento relacionadoIgualCPF, CNPJ
relationshiplevelNível do relacionamentoIgualDireto, Indireto, etc
relationshiptypeTipo do relacionamentoIgualcoworker, neighbor, brother, nephew, mother, son, household, grandson, spouse, relative, grandparent, uncle, cousin, father, partner, related, collegeclass

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

{  
    "Datasets": "related_people.filter(relatedentitytaxidtype=CPF)",
    "q": "doc{CPF}"  
}  

Limite

Para utilizar o campo de limite basta utilizar o parâmetro .limit(x)

{  
    "Datasets": "related_people.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": "related_people.next(Id da próxima página)",
    "q": "doc{CPF}"  
}  

A paginação não pode ser utilizada em conjunto com o referencedate.

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