related 1.1 · Pessoa

Rede de relacionamentos diretos de um CPF: parentesco, vinculo empregaticio e contagem de participacoes societarias.

Entidade	Pessoa (CPF, entity: pf)
Módulo	related
Versão	1.1
Dataset	person-related-1.1
Execução	Roda quando o perfil inclui o módulo

Este é o formato de data.related em GET /api/v3/enrichments/{id}?include=related e o corpo de GET /api/v3/enrichments/{id}/modules/related. Os campos são publicados como o dataset os entrega: um campo ausente significa que o dado não foi obtido, não que o valor é falso ou zero. Os caminhos abaixo são relativos a data.related.

Envelope

Campo	Tipo	Observação
dataset	string	sempre person-related-1.1
module	string	sempre related
related	object	os dados do módulo (abaixo)
rules	array<object>	os indicadores avaliados pelo dataset (abaixo)

Dados

people

Campo	Tipo	Observação
related.people	array<object>
related.people[].deceased	boolean
related.people[].document	string
related.people[].name	string
related.people[].type	string

companies

Campo	Tipo	Observação
related.companies	array<object>
related.companies[].active	boolean
related.companies[].activityCodes	array<string>
related.companies[].document	string
related.companies[].endDate	string	date
related.companies[].name	string
related.companies[].recordAge	string
related.companies[].startDate	string	date
related.companies[].type	string
related.participations.count	integer

Indicadores (rules)

Campo	Tipo	Observação
rules[].evidence	object	Os dados que sustentam o indicador, quando disparou.
rules[].fired	boolean	true quando o indicador se aplica aos dados.
rules[].magnitude	number	Intensidade do achado, quando ele tem uma (ex.: uma contagem ou um valor).
rules[].notApplicable	boolean	true quando o indicador não pôde ser avaliado porque o dado que ele lê está ausente. Não é o mesmo que não disparar.
rules[].reason	string	Por que o indicador não pôde ser avaliado (com notApplicable).
rules[].rule	string	RELATED_PERSON_BUSINESS_BANKRUPTCY, RELATED_PERSON_GHOST_PROFILE — Nome do indicador.

Indicadores publicados por este dataset:

• RELATED_PERSON_BUSINESS_BANKRUPTCY
• RELATED_PERSON_GHOST_PROFILE