# Zarv Developers > Plataforma de gerenciamento de riscos: API REST, SDK web e agente on-premise. Para integrar com a Zarv, comece pelo [Quickstart](https://developers.zarv.com/quickstart.md) ou por [Setup](https://developers.zarv.com/setup.md) — hosts de produção, autenticação por usuário e senha (Bearer JWT) e o loader do SDK. Os specs OpenAPI crus são a fonte da verdade para rotas e schemas: - [Zarv ID v2](https://developers.zarv.com/openapi/id-v2-api.json): legado com perfil, verificações assíncronas por perfil de scoring, dossiê e resumo por IA. - [SmartFlow](https://developers.zarv.com/openapi/smartflow-api.json): fluxo de cadastro passo a passo por agente (dados, OTP de e-mail e telefone, campos personalizados, capturas de facematch e CNH). - [Zarv ID v3](https://developers.zarv.com/openapi/id-v3-api.json): análise de CPF e CNPJ em dois produtos — enriquecimento (os dados de cada módulo; formato de cada dataset em https://developers.zarv.com/api/id-v3/datasets/; processos dos relacionamentos do documento em https://developers.zarv.com/api/id-v3/lawsuits-network.md) e verificação com score e decisão (em desenvolvimento). - [Collector](https://developers.zarv.com/openapi/collector-api.json): ingestão de eventos e telemetria. Limites de uso (429 por workspace nas rotas de verificação): https://developers.zarv.com/api/limits.md ## Table of Contents ### Módulos #### Pessoa (CPF) - [Módulo finance (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/person-finance.md): Zarv ID v3: o módulo finance de pessoa (CPF). Renda estimada, faixa de patrimônio e histórico de declaração do imposto de renda. - [Módulo financeAdvanced (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/person-financeAdvanced.md): Zarv ID v3: o módulo financeAdvanced de pessoa (CPF). Registro negativo de crédito: dívidas vencidas e protestos. - [Módulo lawsuits (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/person-lawsuits.md): Zarv ID v3: o módulo lawsuits de pessoa (CPF). Processos judiciais do documento, classificados na taxonomia do CNJ, com contadores, indicadores de risco… - [Módulo profile (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/person-profile.md): Zarv ID v3: o módulo profile de pessoa (CPF). Cadastro base do documento na Receita Federal e os contatos conhecidos (telefones, e-mails e endereços). - [Módulo related (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/person-related.md): Zarv ID v3: o módulo related de pessoa (CPF). Vínculos do documento com pessoas e empresas: parentesco, sociedade, representação e emprego. ##### finance - [Dataset finance 1.1 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-finance-1-1.md): Zarv ID v3: formato do módulo finance do dataset person-finance-1.1. Renda estimada de um CPF convertida em reais, patrimonio, historico de declaracao de… - [Dataset finance 1.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-finance-1-0.md): Zarv ID v3: formato do módulo finance do dataset person-finance-1.0. Retrato economico de um CPF: renda estimada convertida em reais, patrimonio,… ##### financeAdvanced - [Dataset financeAdvanced 2.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-financeAdvanced-2-0.md): Zarv ID v3: formato do módulo financeAdvanced do dataset person-financeAdvanced-2.0. Registro negativo de credito de uma pessoa: dividas vencidas,… ##### lawsuits - [Dataset lawsuits 3.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-lawsuits-3-0.md): Zarv ID v3: formato do módulo lawsuits do dataset person-lawsuits-3.0. Processos judiciais de um CPF classificados na taxonomia do CNJ, de três fontes… - [Dataset lawsuits 2.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-lawsuits-2-0.md): Zarv ID v3: formato do módulo lawsuits do dataset person-lawsuits-2.0. Processos judiciais de um CPF classificados na taxonomia do CNJ, de duas fontes… - [Dataset lawsuits 1.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-lawsuits-1-0.md): Zarv ID v3: formato do módulo lawsuits do dataset person-lawsuits-1.0. Processos judiciais de um CPF classificados na taxonomia do CNJ, de uma fonte… ##### profile - [Dataset profile 2.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-profile-2-0.md): Zarv ID v3: formato do módulo profile do dataset person-profile-2.0. Cadastro base de um CPF mais os contatos conhecidos: telefones, e-mails e enderecos… - [Dataset profile 1.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-profile-1-0.md): Zarv ID v3: formato do módulo profile do dataset person-profile-1.0. Cadastro base de um CPF na Receita Federal: existencia do documento, identificacao,… ##### related - [Dataset related 2.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-related-2-0.md): Zarv ID v3: formato do módulo related do dataset person-related-2.0. Rede de relacionamentos de um CPF com o parentesco lido de registro alem do… - [Dataset related 1.1 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-related-1-1.md): Zarv ID v3: formato do módulo related do dataset person-related-1.1. Rede de relacionamentos diretos de um CPF: parentesco, vinculo empregaticio e… - [Dataset related 1.0 (pessoa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/person-related-1-0.md): Zarv ID v3: formato do módulo related do dataset person-related-1.0. Rede de relacionamentos de um CPF: vinculos com empresas por registro, e pessoas… #### Empresa (CNPJ) - [Módulo finance (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/company-finance.md): Zarv ID v3: o módulo finance de empresa (CNPJ). Renda estimada, faixa de patrimônio e histórico de declaração do imposto de renda. - [Módulo financeAdvanced (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/company-financeAdvanced.md): Zarv ID v3: o módulo financeAdvanced de empresa (CNPJ). Registro negativo de crédito: dívidas vencidas e protestos. - [Módulo lawsuits (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/company-lawsuits.md): Zarv ID v3: o módulo lawsuits de empresa (CNPJ). Processos judiciais do documento, classificados na taxonomia do CNJ, com contadores, indicadores de… - [Módulo ownersLawsuits (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/company-ownersLawsuits.md): Zarv ID v3: o módulo ownersLawsuits de empresa (CNPJ). Processos judiciais dos sócios do quadro societário de um CNPJ. - [Módulo profile (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/company-profile.md): Zarv ID v3: o módulo profile de empresa (CNPJ). Cadastro base do documento na Receita Federal e os contatos conhecidos (telefones, e-mails e endereços). - [Módulo related (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/modules/company-related.md): Zarv ID v3: o módulo related de empresa (CNPJ). Vínculos do documento com pessoas e empresas: parentesco, sociedade, representação e emprego. ##### finance - [Dataset finance 1.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-finance-1-0.md): Zarv ID v3: formato do módulo finance do dataset company-finance-1.0. Porte e trajetoria de um CNPJ: faixa de faturamento, funcionarios hoje e nas medias… ##### financeAdvanced - [Dataset financeAdvanced 2.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-financeAdvanced-2-0.md): Zarv ID v3: formato do módulo financeAdvanced do dataset company-financeAdvanced-2.0. Registro negativo de credito de uma empresa: dividas vencidas,… ##### lawsuits - [Dataset lawsuits 3.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-lawsuits-3-0.md): Zarv ID v3: formato do módulo lawsuits do dataset company-lawsuits-3.0. Processos judiciais de um CNPJ classificados na taxonomia do CNJ, de três fontes… - [Dataset lawsuits 2.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-lawsuits-2-0.md): Zarv ID v3: formato do módulo lawsuits do dataset company-lawsuits-2.0. Processos judiciais de um CNPJ classificados na taxonomia do CNJ, de duas fontes… - [Dataset lawsuits 1.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-lawsuits-1-0.md): Zarv ID v3: formato do módulo lawsuits do dataset company-lawsuits-1.0. Processos judiciais de um CNPJ classificados na taxonomia do CNJ, de uma fonte… ##### ownersLawsuits - [Dataset ownersLawsuits 1.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-ownersLawsuits-1-0.md): Zarv ID v3: formato do módulo ownersLawsuits do dataset company-ownersLawsuits-1.0. Processos judiciais dos sócios do quadro societário de um CNPJ, um… ##### profile - [Dataset profile 2.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-profile-2-0.md): Zarv ID v3: formato do módulo profile do dataset company-profile-2.0. Cadastro de um CNPJ na Receita Federal: existencia, nomes, situacao cadastral e seu… - [Dataset profile 1.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-profile-1-0.md): Zarv ID v3: formato do módulo profile do dataset company-profile-1.0. Cadastro de um CNPJ na Receita Federal: existencia, nomes, situacao cadastral e seu… ##### related - [Dataset related 2.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-related-2-0.md): 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,… - [Dataset related 1.0 (empresa) - Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets/company-related-1-0.md): Zarv ID v3: formato do módulo related do dataset company-related-1.0. Quadro societario de um CNPJ: quem e socio dela, o que ela detem, e quem a… ### Lead - [Untitled](https://developers.zarv.com/api/smartflow/submitBasic.md) - [Untitled](https://developers.zarv.com/api/smartflow/submitEmail.md) - [Untitled](https://developers.zarv.com/api/smartflow/confirmEmail.md) - [Untitled](https://developers.zarv.com/api/smartflow/submitPhone.md) - [Untitled](https://developers.zarv.com/api/smartflow/confirmPhone.md) - [Untitled](https://developers.zarv.com/api/smartflow/submitAddress.md) - [Untitled](https://developers.zarv.com/api/smartflow/submitCustomField.md) ### Other - [APIs da plataforma Zarv](https://developers.zarv.com/api.md): As APIs REST da Zarv: Zarv ID v2, Zarv ID v3, SmartFlow e Collector, cada uma com seu spec OpenAPI, autenticação e referência de endpoints. - [Atualizações automáticas do Zarv Agent](https://developers.zarv.com/edge-agent/updates.md): Como o Zarv Agent se mantém atualizado sozinho, pelo mesmo canal da instalação (APT, RPM ou Docker), sob controle da Zarv. - [Autenticação da API do Collector](https://developers.zarv.com/api/collector/authentication.md): Como autenticar na API do Collector com HTTP Basic para enviar sinais de GPS e de câmera. - [Autenticação da API do SmartFlow](https://developers.zarv.com/api/smartflow/authentication.md): Como autenticar na API do SmartFlow: login com usuário e senha, token Bearer JWT e renovação com refresh token. - [Autenticação da API do Zarv ID v2](https://developers.zarv.com/api/id-v2/authentication.md): Como autenticar na API do Zarv ID v2: login com usuário e senha, token Bearer JWT e renovação com refresh token. - [Autenticação da API do Zarv ID v3](https://developers.zarv.com/api/id-v3/authentication.md): Como autenticar no Zarv ID v3: login com usuário e senha, token Bearer JWT, renovação com refresh token e chamadas às rotas /api/v3. - [Chat do SDK web](https://developers.zarv.com/sdk/chat.md): Adicione o widget de conversa da Zarv com Zarv('chat', config): configuração, comandos em runtime, eventos e múltiplos agentes. - [Comece em 5 minutos](https://developers.zarv.com/quickstart.md): Da autenticação à primeira verificação de identidade na API do Zarv ID v2: obtenha o token, crie a verificação e receba o resultado por webhook. - [Configuração do Zarv Agent](https://developers.zarv.com/edge-agent/configuration.md): Parâmetros locais de infraestrutura do Zarv Agent: onde ficam, quais variáveis existem e o que é gerenciado centralmente pela Zarv. - [Criação de verificação no Zarv ID v2](https://developers.zarv.com/api/id-v2/creation.md): Como criar uma verificação assíncrona no Zarv ID v2: o POST valida e enfileira, e o resultado chega depois por webhook ou consulta. - [Datasets do Zarv ID v3](https://developers.zarv.com/api/id-v3/datasets.md): Os datasets que um enriquecimento do Zarv ID v3 pode devolver, por entidade, módulo e versão, com o formato do corpo de cada módulo. - [Datasources do Zarv ID](https://developers.zarv.com/api/datasources.md): Consultas brutas e síncronas às fontes de dados, mapeadas para os modelos do Zarv ID, sem verificação, sem fila e sem score. Cobrança por consulta. - [Enriquecimento em lote do Zarv ID v3](https://developers.zarv.com/api/id-v3/enrichment-batch.md): Crie até 500 enriquecimentos do Zarv ID v3 num único request: resposta com o documento de cada item, erros por item, idempotência por bloco e como listar os itens do lote. - [Estrutura do dossiê do Zarv ID v2](https://developers.zarv.com/api/id-v2/structure.md): A estrutura do dossiê consolidado que o Zarv ID v2 retorna quando a verificação chega a COMPLETED, campo a campo. - [Instalação do Zarv Agent](https://developers.zarv.com/edge-agent/installation.md): Instale o Zarv Agent com um único comando, em qualquer sistema operacional: pacote autocontido com ffmpeg, runtime de inferência e modelos. - [Introdução à plataforma Zarv](https://developers.zarv.com/intro.md): As três formas de integrar com a Zarv (API REST, SDK web e Zarv Agent) e qual delas usar em cada projeto. - [Limites de uso da API](https://developers.zarv.com/api/limits.md): Limites de taxa por workspace nas rotas de verificação: 50 requisições por segundo, rajada de 100, e como tratar o 429. - [Limites de uso do Zarv ID v3](https://developers.zarv.com/api/id-v3/limits.md): Limite de taxa das rotas do Zarv ID v3: 50 requisições por segundo, rajada de 100, e como tratar o 429. - [Playground do Smartflow](https://developers.zarv.com/sdk/playground.md): Teste o Smartflow ao vivo: o embed real do SDK contra uma campanha de demonstração, com cada callback registrado na ordem em que dispara. - [Rede de processos do Zarv ID v3](https://developers.zarv.com/api/id-v3/lawsuits-network.md): Como ler os processos dos relacionamentos de um CPF ou CNPJ no Zarv ID v3: quem entra na rede, o formato de cada nó e como ligar a rede ao módulo related. - [Registro do Zarv Agent](https://developers.zarv.com/edge-agent/enrollment.md): Registre (enrollment) o Zarv Agent uma única vez depois de instalar, para que ele se identifique e receba a configuração da Zarv. - [SDK web da Zarv](https://developers.zarv.com/sdk.md): Um único loader, js.zarv.com/sdk.js, serve o Chat e o Smartflow sob o mesmo window.Zarv. Instalação, chave pública e contrato imperativo. - [Setup para agentes de código](https://developers.zarv.com/setup.md): Integre a Zarv com Claude Code, Codex ou Cursor: aponte o agente para o llms.txt e use os hosts, a autenticação e o loader do SDK documentados. - [Smartflow: cadastro e KYC no seu site](https://developers.zarv.com/sdk/smartflow.md): Embuta o funnel de cadastro e KYC da Zarv com Zarv('smartflow', config): telas, prefill, callbacks, identify e complete. - [Solução de problemas do Zarv Agent](https://developers.zarv.com/edge-agent/troubleshooting.md): Guia rápido para diagnosticar o Zarv Agent: logs, endpoints de saúde, serviço, interface local, conexão, registro, câmeras e disco. - [Webhook da campanha](https://developers.zarv.com/sdk/webhooks.md): Receba no seu servidor cada etapa e a decisão final do cadastro, por HTTPS assinado com HMAC-SHA256. Verificação, idempotência e retentativas. - [Webhook de enriquecimento do Zarv ID v3](https://developers.zarv.com/api/id-v3/webhook.md): Receba o fim de um enriquecimento do Zarv ID v3 por callback assinado com HMAC-SHA256: headers, payload, verificação da assinatura e reentregas. - [Webhook de verificação do Zarv ID v2](https://developers.zarv.com/api/id-v2/webhook.md): Receba o resultado das verificações do Zarv ID v2 quando o status muda para COMPLETED ou FAILED, sem precisar consultar a API. - [Zarv Agent (Edge Agent)](https://developers.zarv.com/edge-agent.md): O Zarv Agent processa câmeras RTSP/ONVIF on-premise, com visão computacional local, e envia à Zarv apenas os eventos relevantes. - [Zarv ID v3: guia rápido de integração](https://developers.zarv.com/api/id-v3/quickstart.md): Integre o enriquecimento do Zarv ID v3 em 5 passos: autentique, crie o enriquecimento, aguarde por webhook ou polling e busque os dados de cada módulo. - [Zarv ID v3: visão geral](https://developers.zarv.com/api/id-v3.md): Zarv ID v3: plataforma de análise de CPF e CNPJ. Enriquecimento com os dados de cada módulo como os datasets publicam, resposta síncrona em até 25s, polling ou callback assinado.