---
url: https://developers.zarv.com/api/id-v3/datasets/person-finance-1-0.md
description: >-
  Zarv ID v3: formato de data.finance do dataset person-finance-1.0. Retrato
  economico de um CPF: renda estimada convertida em reais, patrimonio,
  historico…
---

# finance 1.0 · Pessoa

Retrato economico de um CPF: renda estimada convertida em reais, patrimonio, historico de declaracao de imposto de renda, historico de cobranca e beneficios sociais com extrato de pagamentos.

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

Este é o formato de `data.finance` em [`GET /api/v3/enrichments/{id}?include=finance`](/api/id-v3/getEnrichment) e o corpo de [`GET /api/v3/enrichments/{id}/modules/finance`](/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.finance`.

## Envelope

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

## Dados

### `income`

| Campo                       | Tipo     | Observação |
| --------------------------- | -------- | ---------- |
| `finance.income.monthlyBRL` | `number` |            |
| `finance.income.band`       | `string` |            |
| `finance.income.basis`      | `string` |            |
| `finance.assets`            | `string` |            |

### `taxReturns`

| Campo                               | Tipo            | Observação |
| ----------------------------------- | --------------- | ---------- |
| `finance.taxReturns.years`          | `integer`       |            |
| `finance.taxReturns.filed`          | `integer`       |            |
| `finance.taxReturns.latest`         | `string`        |            |
| `finance.taxReturns.items`          | `array<object>` |            |
| `finance.taxReturns.items[].filed`  | `boolean`       |            |
| `finance.taxReturns.items[].status` | `string`        |            |
| `finance.taxReturns.items[].year`   | `string`        |            |

### `debts`

| Campo                                | Tipo      | Observação |
| ------------------------------------ | --------- | ---------- |
| `finance.debts.current`              | `boolean` |            |
| `finance.debts.months`               | `integer` |            |
| `finance.debts.consecutiveMonths`    | `integer` |            |
| `finance.debts.maxConsecutiveMonths` | `integer` |            |
| `finance.debts.occurrences`          | `integer` |            |
| `finance.debts.origins`              | `integer` |            |
| `finance.debts.last30Days`           | `integer` |            |
| `finance.debts.last90Days`           | `integer` |            |
| `finance.debts.last180Days`          | `integer` |            |
| `finance.debts.last365Days`          | `integer` |            |
| `finance.debts.firstAt`              | `string`  | date       |
| `finance.debts.lastAt`               | `string`  | date       |

### `assistance`

| Campo                                                         | Tipo            | Observação |
| ------------------------------------------------------------- | --------------- | ---------- |
| `finance.assistance.receiving`                                | `boolean`       |            |
| `finance.assistance.total`                                    | `integer`       |            |
| `finance.assistance.active`                                   | `integer`       |            |
| `finance.assistance.amountReceived`                           | `number`        |            |
| `finance.assistance.installments`                             | `integer`       |            |
| `finance.assistance.items`                                    | `array<object>` |            |
| `finance.assistance.items[].active`                           | `boolean`       |            |
| `finance.assistance.items[].amount`                           | `number`        |            |
| `finance.assistance.items[].context`                          | `string`        |            |
| `finance.assistance.items[].endDate`                          | `string`        | date       |
| `finance.assistance.items[].installments`                     | `integer`       |            |
| `finance.assistance.items[].name`                             | `string`        |            |
| `finance.assistance.items[].payments`                         | `object`        |            |
| `finance.assistance.items[].payments.count`                   | `integer`       |            |
| `finance.assistance.items[].payments.duplicateReferenceDates` | `integer`       |            |
| `finance.assistance.items[].payments.first`                   | `number`        |            |
| `finance.assistance.items[].payments.last`                    | `number`        |            |
| `finance.assistance.items[].payments.sum`                     | `number`        |            |
| `finance.assistance.items[].payments.values`                  | `array<object>` |            |
| `finance.assistance.items[].payments.values[].count`          | `integer`       |            |
| `finance.assistance.items[].payments.values[].value`          | `number`        |            |
| `finance.assistance.items[].startDate`                        | `string`        | date       |
| `finance.assistance.items[].state`                            | `string`        |            |
| `finance.assistance.items[].totalAmount`                      | `number`        |            |

## 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`  | `FINANCE_PERSON_ASSISTANCES`, `FINANCE_PERSON_DEBTS_HISTORY`, `FINANCE_PERSON_INCOME`, `FINANCE_PERSON_NO_TAX_RETURNS`, `FINANCE_PERSON_SOCIAL_ASSISTANCES` — Nome do indicador. |

Indicadores publicados por este dataset:

* `FINANCE_PERSON_ASSISTANCES`
* `FINANCE_PERSON_DEBTS_HISTORY`
* `FINANCE_PERSON_INCOME`
* `FINANCE_PERSON_NO_TAX_RETURNS`
* `FINANCE_PERSON_SOCIAL_ASSISTANCES`