---
url: https://developers.zarv.com/api/id-v3/datasets/person-related-1-0.md
description: >-
  Zarv ID v3: formato do módulo related do dataset person-related-1.0. Rede de
  relacionamentos de um CPF: vinculos com empresas por registro, e pessoas…
---

# related 1.0 · Pessoa

Rede de relacionamentos de um CPF: vinculos com empresas por registro, e pessoas relacionadas por inferencia.

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

Este é o formato do corpo de [`GET /api/v3/enrichments/{id}/modules/related`](/api/id-v3/getEnrichmentModule), 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.0` |
| `module`  | `string` | sempre `related`            |
| `related` | `object` | os dados do módulo (abaixo) |

## Dados

### `companies`

| Campo                           | Tipo            | Observação |
| ------------------------------- | --------------- | ---------- |
| `related.companies`             | `array<object>` |            |
| `related.companies[].active`    | `boolean`       |            |
| `related.companies[].document`  | `string`        |            |
| `related.companies[].endDate`   | `string`        | date       |
| `related.companies[].level`     | `string`        |            |
| `related.companies[].name`      | `string`        |            |
| `related.companies[].role`      | `string`        |            |
| `related.companies[].startDate` | `string`        | date       |
| `related.companies[].subtype`   | `string`        |            |
| `related.companies[].type`      | `string`        |            |
| `related.business.truncated`    | `boolean`       |            |

### `people`

| Campo                        | Tipo            | Observação |
| ---------------------------- | --------------- | ---------- |
| `related.people`             | `array<object>` |            |
| `related.people[].active`    | `boolean`       |            |
| `related.people[].document`  | `string`        |            |
| `related.people[].endDate`   | `string`        | date       |
| `related.people[].level`     | `string`        |            |
| `related.people[].name`      | `string`        |            |
| `related.people[].startDate` | `string`        | date       |
| `related.people[].type`      | `string`        |            |

### `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`        |            |