Developers

Aparência

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-lawsuits-2-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]

lawsuits 2.0 · Empresa ​

Processos judiciais de um CNPJ classificados na taxonomia do CNJ, de duas fontes processuais: contadores por natureza, janelas de tempo, indicadores, e cada processo por inteiro.

EntidadeEmpresa (CNPJ, entity: pj)
Módulolawsuits
Versão2.0 (mais recente)
Datasetcompany-lawsuits-2.0
ExecuçãoRoda quando o perfil inclui o módulo

Este é o formato de data.lawsuits em GET /api/v3/enrichments/{id}?include=lawsuits e o corpo de GET /api/v3/enrichments/{id}/modules/lawsuits. 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.lawsuits.

Envelope ​

CampoTipoObservação
datasetstringsempre company-lawsuits-2.0
modulestringsempre lawsuits
lawsuitsobjectos dados do módulo (abaixo)
rulesarray<object>os indicadores avaliados pelo dataset (abaixo)

Dados ​

coverage ​

CampoTipoObservação
lawsuits.coverage.totalinteger
lawsuits.coverage.distinctCasesinteger
lawsuits.coverage.discardedAsNonDisputantinteger
lawsuits.coverage.truncatedboolean
lawsuits.coverage.inferenceRatenumber

counters ​

CampoTipoObservação
lawsuits.counters.totalinteger
lawsuits.counters.asActiveinteger
lawsuits.counters.asPassiveinteger
lawsuits.counters.criminalinteger
lawsuits.counters.civilinteger
lawsuits.counters.taxExecutioninteger
lawsuits.counters.laborinteger
lawsuits.counters.administrativeinteger
lawsuits.counters.sexualOffenseinteger
lawsuits.counters.drugsinteger
lawsuits.counters.bankruptcyinteger

windows ​

CampoTipoObservação
lawsuits.windows.last30Daysinteger
lawsuits.windows.last90Daysinteger
lawsuits.windows.last180Daysinteger
lawsuits.windows.last365Daysinteger

dimensions ​

CampoTipoObservação
lawsuits.dimensionsmap<string, object>

relationships ​

CampoTipoObservação
lawsuits.relationshipsmap<string, object>

indicators ​

CampoTipoObservação
lawsuits.indicatorsmap<string, object>

items ​

CampoTipoObservação
lawsuits.itemsarray<any>

Indicadores (rules) ​

CampoTipoObservação
rules[].evidenceobjectOs dados que sustentam o indicador, quando disparou.
rules[].firedbooleantrue quando o indicador se aplica aos dados.
rules[].magnitudenumberIntensidade do achado, quando ele tem uma (ex.: uma contagem ou um valor).
rules[].notApplicablebooleantrue 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[].reasonstringPor que o indicador não pôde ser avaliado (com notApplicable).
rules[].rulestringLAWSUITS_COMPANY_HISTORY_INFERRED, LAWSUITS_COMPANY_ONLY_AS_NON_DISPUTANT, LAWSUITS_COMPANY_TRUNCATED — Nome do indicador.

Indicadores publicados por este dataset:

  • LAWSUITS_COMPANY_HISTORY_INFERRED
  • LAWSUITS_COMPANY_ONLY_AS_NON_DISPUTANT
  • LAWSUITS_COMPANY_TRUNCATED