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/modules/
- 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]

Módulos ​

Um módulo é a chave estável da rota (/api/v3/enrichments/{id}/modules/{module}) e da chave de data. Um dataset é uma versão publicada do módulo; o perfil escolhe qual versão roda. Cada página de módulo lista as versões e leva aos datasets.

A tabela de todas as versões publicadas está em Datasets.

Pessoa (CPF) ​

  • finance: Renda estimada, faixa de patrimônio e histórico de declaração do imposto de renda.
  • financeAdvanced: Registro negativo de crédito: dívidas vencidas e protestos.
  • lawsuits: Processos judiciais do documento, classificados na taxonomia do CNJ, com contadores, indicadores de risco e a lista de processos.
  • profile: Cadastro base do documento na Receita Federal e os contatos conhecidos (telefones, e-mails e endereços).
  • related: Vínculos do documento com pessoas e empresas: parentesco, sociedade, representação e emprego.

Empresa (CNPJ) ​

  • finance: Renda estimada, faixa de patrimônio e histórico de declaração do imposto de renda.
  • financeAdvanced: Registro negativo de crédito: dívidas vencidas e protestos.
  • lawsuits: Processos judiciais do documento, classificados na taxonomia do CNJ, com contadores, indicadores de risco e a lista de processos.
  • ownersLawsuits: Processos judiciais dos sócios do quadro societário de um CNPJ.
  • profile: Cadastro base do documento na Receita Federal e os contatos conhecidos (telefones, e-mails e endereços).
  • related: Vínculos do documento com pessoas e empresas: parentesco, sociedade, representação e emprego.