Enriquecimento de CPF e CNPJ: a partir de um documento e de um perfil, a Zarv consulta os datasets do perfil e devolve, por módulo, os dados exatamente como os datasets os publicam — sem regras, score ou análise por IA.
Todas as rotas usam token Bearer JWT; veja Autenticação. O callback assinado está em Webhook e o formato de cada módulo em Datasets.
Documentos. CPF ou CNPJ, incluindo o CNPJ alfanumérico de 2026 (ex.: 12ABC34501DE35); pontuação e caixa são ignoradas. As respostas trazem o documento normalizado completo.
Servers
Consultar o segredo de assinatura do callback
Cada callback é assinado com X-Zarv-Signature: sha256=<hex>, o HMAC-SHA256 deste segredo sobre "{X-Zarv-Timestamp}.{corpo}". Veja Webhook.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Responses
O segredo, em hexadecimal.
Listar enriquecimentos
Mais recentes primeiro. Os itens são resumos, sem modules.
from, to, document, profileId e entity são opcionais e se combinam (todos precisam valer). Eles não vão dentro do nextCursor: repita os mesmos filtros em todas as páginas da mesma listagem.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Parameters
Query Parameters
O nextCursor da página anterior.
Itens por página. Valores acima de 100 são reduzidos para 100.
201Só enriquecimentos criados a partir deste instante, inclusive. RFC3339, por exemplo 2026-09-01T00:00:00-03:00.
"date-time"Só enriquecimentos criados antes deste instante, exclusive. RFC3339. Para o dia 01/09 inteiro: from=2026-09-01T00:00:00-03:00&to=2026-09-02T00:00:00-03:00.
"date-time"CPF ou CNPJ, com ou sem máscara, validado como na criação.
Só enriquecimentos deste perfil.
person (CPF) ou company (CNPJ), o mesmo valor de entity na resposta. pf e pj também são aceitos.
"person""company""pf""pj"Só os enriquecimentos criados por este lote (bat_…), o batchId da resposta de POST /api/v3/enrichments/batch.
interactive (criação unitária) ou batch (criação em lote).
"interactive""batch"Responses
Uma página.
Criar um enriquecimento
Valida a requisição, resolve o perfil (do seu workspace ou um perfil global da Zarv), planeja os módulos, confere o contrato do workspace e cria o enriquecimento. Depois, a requisição espera até 25 segundos por um status terminal:
- terminou a tempo:
200com a raiz do enriquecimento (o estado de cada módulo, sem os dados); leia cada módulo emmodules.{módulo}.url; - não terminou:
202com{id, status}; se houvercallback, ele é entregue quando o enriquecimento terminar; - mesma
Idempotency-Keye mesmo corpo (a chave não expira):200com o corpo do GET quando o enriquecimento já terminou,202com{id, status}enquanto ainda roda (umcallbackenviado junto é rearmado); - mesma
Idempotency-Keycom corpo diferente:422 idempotency_key_reused.
O processamento continua mesmo que o cliente feche a conexão. Uma resposta não terminal traz Retry-After: consulte GET /api/v3/enrichments/{id} depois desse intervalo, ou espere o callback.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Parameters
Header Parameters
Chave de idempotência, até 255 caracteres (ex.: um UUID). A chave não expira: a mesma chave com o mesmo corpo sempre devolve o mesmo enriquecimento, sem nova cobrança. Para uma consulta nova, use uma chave nova.
255Request Body
Responses
Terminou dentro da espera síncrona, ou replay idempotente de um enriquecimento já terminado.
Criar enriquecimentos em lote
Cria até 500 enriquecimentos que compartilham o mesmo perfil, options, callback e metadata, numa fila própria, separada da unitária (um lote grande nunca atrasa as consultas unitárias). Diferente da criação unitária, não há espera síncrona: a resposta é 202 assim que os itens estão gravados.
A resposta traz uma entrada por item enviado, na ordem do request, cada uma com o seu index e o seu document, o documento exatamente como enviado (sem normalização): cada documento enviado mapeia para o seu id ou o seu error. A mensagem de erro nunca traz o documento. Um item que não pode ser criado (invalid_document, profile_entity_mismatch, duplicate_in_request, invalid_metadata) traz error, não é cobrado e os demais seguem. O metadata do item sobrescreve o metadata do lote chave a chave (raso).
Problemas do request inteiro não criam nada e usam os códigos da criação unitária, além de batch_empty e batch_too_large. A mesma Idempotency-Key com o mesmo corpo devolve a primeira resposta (os documentos vêm do corpo reenviado; nada os guarda); com corpo diferente, 422 idempotency_key_reused.
Não existe endpoint de status do lote: leia cada item com GET /api/v3/enrichments/{id} ou liste-os com GET /api/v3/enrichments?batchId=. Veja Enriquecimento em lote.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Parameters
Header Parameters
Chave de idempotência do request (do bloco), até 255 caracteres. Reenviar o mesmo bloco com a mesma chave não duplica nem cobra de novo.
255Request Body
Responses
O lote foi processado; o resultado de cada item está em items, por index.
Consultar um enriquecimento
A raiz do enriquecimento: status, resultado e o estado de cada módulo. Enquanto o status não é terminal, a resposta traz Retry-After. Não traz os dados dos módulos: leia cada um em modules.{módulo}.url.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Responses
O enriquecimento.
Consultar a rede de processos
Os processos dos relacionamentos do documento consultado — familiares, sócios, empresas e co-réus —, um item por CPF/CNPJ em nodes, com a chave igual ao documento que aparece no módulo related. Cada nó traz os contadores e indicadores do dataset de processos (sem a lista de processos), as relações pelas quais ele foi encontrado e o status da consulta. Veja Rede de processos.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Responses
A rede, ou status: skipped com o motivo quando ela não roda (related_disabled, lawsuits_disabled, network_not_configured, subject_not_found ou not_run, para um enriquecimento concluído sem a etapa da rede).
Consultar os processos de um nó da rede
Os processos de um nó, no formato do dataset de processos, com a lista completa em lawsuits.items. Use o ref que vem em GET …/modules/lawsuits/network; o documento nunca vai na URL.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Responses
O nó e os seus processos.
Consultar os dados de um módulo
Os dados de um módulo concluído, no formato publicado pelo dataset. Os módulos que um enriquecimento roda são os do perfil usado na criação: consulte GET /api/v3/profiles/{id} (ou GET /api/v3/profiles) para ver cada módulo do perfil e o dataset dele. Na raiz do enriquecimento (GET /api/v3/enrichments/{id}), modules lista os módulos deste enriquecimento e o status de cada um. O formato de cada dataset está em Datasets.
Módulo ({module}) |
Pessoa (CPF) | Empresa (CNPJ) | O que traz |
|---|---|---|---|
finance |
1.0, 1.1 | 1.0 | Renda estimada, faixa de patrimônio e histórico de declaração do imposto de renda. |
financeAdvanced |
2.0 | 2.0 | Registro negativo de crédito: dívidas vencidas e protestos. |
lawsuits |
1.0, 2.0, 3.0 | 1.0, 2.0, 3.0 | Processos judiciais do documento, classificados na taxonomia do CNJ, com contadores, indicadores de risco e a lista de processos. |
ownersLawsuits |
— | 1.0 | Processos judiciais dos sócios do quadro societário de um CNPJ. |
profile |
1.0, 2.0 | 1.0, 2.0 | Cadastro base do documento na Receita Federal e os contatos conhecidos (telefones, e-mails e endereços). |
related |
1.0, 1.1, 2.0 | 1.0, 2.0 | Vínculos do documento com pessoas e empresas: parentesco, sociedade, representação e emprego. |
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Responses
Os dados do módulo.
Listar perfis
Os perfis ativos do seu workspace, de todos os tipos. O campo profile.kind diz o tipo de cada um: um enriquecimento só roda perfis enrichment. Use ?kind=enrichment para listar só os que servem em POST /api/v3/enrichments. Cada item tem o mesmo formato de GET /api/v3/profiles/{id}: o perfil, a entidade que ele atende e o dataset de cada módulo. A lista não é paginada.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Parameters
Query Parameters
Só perfis deste tipo: enrichment ou verification. Sem o parâmetro, lista todos.
"enrichment""verification"Responses
Os perfis do workspace.
Consultar um perfil
O perfil (com o tipo em profile.kind), a entidade que ele atende (person para CPF, company para CNPJ) e, em modules, o dataset que cada módulo usa, no mesmo formato de modules na resposta do enriquecimento. Veja o formato de cada dataset em Datasets. Depois que um enriquecimento com este perfil conclui, cada módulo listado aqui pode ser lido em GET /api/v3/enrichments/{id}/modules/{module}.
Authorizations
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Responses
O perfil.