---
url: https://developers.zarv.com/api/id-v3/datasets/company-related-2-0.md
description: >-
  Zarv ID v3: formato do módulo related do dataset company-related-2.0. Quadro
  societario de um CNPJ mais o grupo por raiz do documento: matriz e filiais,…
---

# related 2.0 · Empresa

Quadro societario de um CNPJ mais o grupo por raiz do documento: matriz e filiais, com a distribuicao de situacao cadastral e de regime sobre o grupo inteiro.

|          |                                      |
| -------- | ------------------------------------ |
| Entidade | Empresa (CNPJ, `entity: pj`)         |
| Módulo   | `related`                            |
| Versão   | `2.0` (mais recente)                 |
| Dataset  | `company-related-2.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 `company-related-2.0` |
| `module`  | `string` | sempre `related`             |
| `related` | `object` | os dados do módulo (abaixo)  |

## Dados

### `totals`

| Campo                     | Tipo      | Observação |
| ------------------------- | --------- | ---------- |
| `related.owners.count`    | `integer` |            |
| `related.owned.count`     | `integer` |            |
| `related.employees.count` | `integer` |            |
| `related.indirect.count`  | `integer` |            |
| `related.foreign.count`   | `integer` |            |

### `character`

| Campo                           | Tipo      | Observação |
| ------------------------------- | --------- | ---------- |
| `related.isFamilyCompany`       | `boolean` |            |
| `related.isFamilyOperated`      | `boolean` |            |
| `related.truncated`             | `boolean` |            |
| `related.oldestStartDate`       | `string`  | date       |
| `related.lastOwnershipChangeAt` | `string`  | date       |

### `parties`

| Campo                         | Tipo            | Observação |
| ----------------------------- | --------------- | ---------- |
| `related.parties`             | `array<object>` |            |
| `related.parties[].active`    | `boolean`       |            |
| `related.parties[].country`   | `string`        |            |
| `related.parties[].endDate`   | `string`        | date       |
| `related.parties[].level`     | `string`        |            |
| `related.parties[].name`      | `string`        |            |
| `related.parties[].role`      | `string`        |            |
| `related.parties[].startDate` | `string`        | date       |
| `related.parties[].taxId`     | `string`        |            |
| `related.parties[].taxIdType` | `string`        |            |
| `related.parties[].type`      | `string`        |            |
| `related.parties[].via`       | `string`        |            |
| `related.parties[].viaRole`   | `string`        |            |

### `group`

| Campo                              | Tipo                   | Observação |
| ---------------------------------- | ---------------------- | ---------- |
| `related.group.type`               | `string`               |            |
| `related.group.active`             | `integer`              |            |
| `related.group.inactive`           | `integer`              |            |
| `related.group.headquarters`       | `integer`              |            |
| `related.group.branches`           | `integer`              |            |
| `related.group.statusDistribution` | `map<string, integer>` |            |
| `related.group.regimeDistribution` | `map<string, integer>` |            |
| `related.group.documents`          | `array<string>`        |            |
| `related.group.truncated`          | `boolean`              |            |

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