---
url: https://developers.zarv.com/api/id-v3/datasets/person-related-2-0.md
description: >-
  Zarv ID v3: formato de data.related do dataset person-related-2.0. Rede de
  relacionamentos de um CPF com o parentesco lido de registro alem do inferido,…
---

# related 2.0 · Pessoa

Rede de relacionamentos de um CPF com o parentesco lido de registro alem do inferido, e a natureza de cada linha declarada em basis.

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

Este é o formato de `data.related` em [`GET /api/v3/enrichments/{id}?include=related`](/api/id-v3/getEnrichment) e o corpo de [`GET /api/v3/enrichments/{id}/modules/related`](/api/id-v3/getEnrichmentModule). 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-2.0`                    |
| `module`  | `string`        | sempre `related`                               |
| `related` | `object`        | os dados do módulo (abaixo)                    |
| `rules`   | `array<object>` | os indicadores avaliados pelo dataset (abaixo) |

## Dados

### `business`

| Campo                                      | Tipo      | Observação |
| ------------------------------------------ | --------- | ---------- |
| `related.business.ownerships.count`        | `integer` |            |
| `related.business.employments.count`       | `integer` |            |
| `related.business.partners.count`          | `integer` |            |
| `related.business.clients.count`           | `integer` |            |
| `related.business.suppliers.count`         | `integer` |            |
| `related.business.activeOwnerships.count`  | `integer` |            |
| `related.business.activeEmployments.count` | `integer` |            |
| `related.business.truncated`               | `boolean` |            |

### `personal`

| Campo                                 | Tipo      | Observação |
| ------------------------------------- | --------- | ---------- |
| `related.personal.relatives.count`    | `integer` |            |
| `related.personal.neighbors.count`    | `integer` |            |
| `related.personal.spouses.count`      | `integer` |            |
| `related.personal.coworkers.count`    | `integer` |            |
| `related.personal.household.count`    | `integer` |            |
| `related.personal.partners.count`     | `integer` |            |
| `related.personal.collegeClass.count` | `integer` |            |

### `companies`

| Campo                           | Tipo            | Observação |
| ------------------------------- | --------------- | ---------- |
| `related.companies`             | `array<object>` |            |
| `related.companies[].active`    | `boolean`       |            |
| `related.companies[].basis`     | `string`        |            |
| `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[].type`      | `string`        |            |

### `people`

| Campo                        | Tipo            | Observação |
| ---------------------------- | --------------- | ---------- |
| `related.people`             | `array<object>` |            |
| `related.people[].active`    | `boolean`       |            |
| `related.people[].basis`     | `string`        |            |
| `related.people[].deceased`  | `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`        |            |

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