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/getEnrichment
- 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 um enriquecimento​

GET
/api/v3/enrichments/{id}

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​

bearerAuth

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

Type
HTTP (bearer)

Responses​

O enriquecimento.

application/json
JSON
{
  
"batchId": "string",
  
"completedAt": "string",
  
"createdAt": "string",
  
"deadline": "string",
  
"document": "string",
  
"entity": "string",
  
"failureReason": "string",
  
"id": "enr_0199a0b2-7c1e-7d4a-9f0e-3b1c2d4e5f60",
  
"lane": "string",
  
"metadata": {
  
  
"additionalProperties": "string"
  
},
  
"modules": {
  
  
"additionalProperties": {
  
  
  
"dataset": "string",
  
  
  
"network": {
  
  
  
  
"documents": 0,
  
  
  
  
"reason": "related_disabled",
  
  
  
  
"status": "string",
  
  
  
  
"url": "/api/v3/enrichments/enr_01a0f9bd/modules/lawsuits/network",
  
  
  
  
"withLawsuits": 0
  
  
  
},
  
  
  
"nextAttemptAt": "string",
  
  
  
"status": "string",
  
  
  
"url": "/api/v3/enrichments/enr_01a0f9bd/modules/finance"
  
  
}
  
},
  
"nextRetryAt": "string",
  
"outcome": "subject_not_found",
  
"profile": {
  
  
"id": "string",
  
  
"kind": "string",
  
  
"name": "string"
  
},
  
"recoveryRound": 0,
  
"status": "string",
  
"userId": "usr_0199a0b2-7c1e-7d4a-9f0e-3b1c2d4e5f60",
  
"workspaceId": "ws_0199a0b2-7c1e-7d4a-9f0e-3b1c2d4e5f60"
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI