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 do corpo de GET /api/v3/enrichments/{id}/modules/related, a rota que a url do módulo, na raiz do enriquecimento, aponta. 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 ao corpo da resposta.
Envelope
| Campo | Tipo | Observação |
|---|---|---|
dataset | string | sempre person-related-1.1 |
module | string | sempre related |
related | object | os dados do módulo (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 |
timeline
| Campo | Tipo | Observação |
|---|---|---|
related.timeline | array<object> | |
related.timeline[].amountBrl | number | |
related.timeline[].basis | string | |
related.timeline[].date | string | |
related.timeline[].detail | string | |
related.timeline[].event | string | |
related.timeline[].precision | string | |
related.timeline[].ref | string | |
related.timeline[].source | string |