Skip to content
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/getEnrichmentNetwork
- 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]

Consultar a rede de processos​

GET
/api/v3/enrichments/{id}/modules/lawsuits/network

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​

bearerAuth

Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.

Type
HTTP (bearer)

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).

application/json
JSON
{
  
"candidates": 0,
  
"nodes": {
  
  
"additionalProperties": {
  
  
  
"counters": {
  
  
  
  
"administrative": 0,
  
  
  
  
"asActive": 0,
  
  
  
  
"asPassive": 0,
  
  
  
  
"bankruptcy": 0,
  
  
  
  
"civil": 0,
  
  
  
  
"criminal": 0,
  
  
  
  
"drugs": 0,
  
  
  
  
"labor": 0,
  
  
  
  
"sexualOffense": 0,
  
  
  
  
"taxExecution": 0,
  
  
  
  
"total": 0
  
  
  
},
  
  
  
"coverage": {
  
  
  
  
"discardedAsNonDisputant": 0,
  
  
  
  
"distinctCases": 0,
  
  
  
  
"inferenceRate": 0,
  
  
  
  
"total": 0,
  
  
  
  
"truncated": true
  
  
  
},
  
  
  
"dimensions": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"indicatorCount": 0,
  
  
  
  
  
"lawsuitCount": 0
  
  
  
  
}
  
  
  
},
  
  
  
"indicators": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"activeRatio": 0,
  
  
  
  
  
"count": 0,
  
  
  
  
  
"countByStage": {
  
  
  
  
  
  
"additionalProperties": 0
  
  
  
  
  
}
  
  
  
  
}
  
  
  
},
  
  
  
"relationships": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"lawsuitCount": 0
  
  
  
  
}
  
  
  
},
  
  
  
"windows": {
  
  
  
  
"last180Days": 0,
  
  
  
  
"last30Days": 0,
  
  
  
  
"last365Days": 0,
  
  
  
  
"last90Days": 0
  
  
  
}
  
  
}
  
},
  
"reason": "string",
  
"selected": 0,
  
"status": "string"
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI