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

Listar enriquecimentos​

GET
/api/v3/enrichments

Mais recentes primeiro. Os itens são resumos, sem modules e sem data.

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​

bearerAuth

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

Type
HTTP (bearer)

Parameters​

Query Parameters

cursor

O nextCursor da página anterior.

Type
string
limit

Itens por página. Valores acima de 100 são reduzidos para 100.

Type
integer
Default
20
Minimum
1
from

Só enriquecimentos criados a partir deste instante, inclusive. RFC3339, por exemplo 2026-09-01T00:00:00-03:00.

Type
string
Format
"date-time"
to

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.

Type
string
Format
"date-time"
document

CPF ou CNPJ, com ou sem máscara, validado como na criação.

Type
string
profileId

Só enriquecimentos deste perfil.

Type
string
entity

person (CPF) ou company (CNPJ), o mesmo valor de entity na resposta. pf e pj também são aceitos.

Type
string
Valid values
"person""company""pf""pj"

Responses​

Uma página.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"completedAt": "string",
  
  
  
"createdAt": "string",
  
  
  
"data": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"deadline": "string",
  
  
  
"document": "string",
  
  
  
"entity": "string",
  
  
  
"failureReason": "string",
  
  
  
"id": "enr_0199a0b2-7c1e-7d4a-9f0e-3b1c2d4e5f60",
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"modules": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"dataset": "string",
  
  
  
  
  
"nextAttemptAt": "string",
  
  
  
  
  
"status": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"nextRetryAt": "string",
  
  
  
"outcome": "subject_not_found",
  
  
  
"profile": {
  
  
  
  
"id": "string",
  
  
  
  
"kind": "string",
  
  
  
  
"name": "string"
  
  
  
},
  
  
  
"recoveryRound": 0,
  
  
  
"status": "string"
  
  
}
  
],
  
"nextCursor": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI