Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.

Ver a instrução

Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/id-v3/datasets/company-finance-1-0
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

finance 1.0 · Empresa

Porte e trajetoria de um CNPJ: faixa de faturamento, funcionarios hoje e nas medias de 1, 3 e 5 anos, filiais, socios, capital, indice de atividade e historico de cobranca.


Entidade	Empresa (CNPJ, `entity: pj`)
Módulo	`finance`
Versão	`1.0` (mais recente)
Dataset	`company-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 e o corpo de GET /api/v3/enrichments/{id}/modules/finance. 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 `company-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

`revenue`

Campo	Tipo	Observação
`finance.revenue.band`	`string`
`finance.revenue.floorBRL`	`number`

`workforce`

Campo	Tipo	Observação
`finance.workforce.count`	`integer`
`finance.workforce.band`	`string`
`finance.workforce.avg1y`	`integer`
`finance.workforce.avg3y`	`integer`
`finance.workforce.avg5y`	`integer`
`finance.workforce.min`	`integer`
`finance.workforce.max`	`integer`

`structure`

Campo	Tipo	Observação
`finance.structure.branches.count`	`integer`
`finance.structure.branches.avg1y`	`integer`
`finance.structure.branches.avg3y`	`integer`
`finance.structure.branches.avg5y`	`integer`
`finance.structure.partners.count`	`integer`
`finance.structure.partners.avg1y`	`integer`
`finance.structure.partners.avg3y`	`integer`
`finance.structure.partners.avg5y`	`integer`
`finance.structure.partners.everChanged`	`boolean`
`finance.structure.capital.value`	`number`
`finance.structure.capital.everChanged`	`boolean`

`activity`

Campo	Tipo	Observação
`finance.activity.level`	`number`
`finance.activity.min`	`number`
`finance.activity.max`	`number`
`finance.activity.average`	`number`

`history`

Campo	Tipo	Observação
`finance.history.months`	`integer`
`finance.history.from`	`string`	date
`finance.history.to`	`string`	date

`debts`

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

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_COMPANY_DEBTS_HISTORY`, `FINANCE_COMPANY_REVENUE_INACTIVE`, `FINANCE_COMPANY_REVENUE_UNKNOWN`, `FINANCE_COMPANY_WORKFORCE_SHRANK` — Nome do indicador.

Indicadores publicados por este dataset:

FINANCE_COMPANY_DEBTS_HISTORY
FINANCE_COMPANY_REVENUE_INACTIVE
FINANCE_COMPANY_REVENUE_UNKNOWN
FINANCE_COMPANY_WORKFORCE_SHRANK