Developers

Aparência

Vai integrar a API do Decision Engine 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 do Decision Engine. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/decision-engine/get-api-v2-blacklist
- Spec OpenAPI (fonte da verdade para rotas e schemas): https://developers.zarv.com/openapi/decision-engine-api.json
- Autenticação: https://developers.zarv.com/api/decision-engine/authentication
- Webhook de verificação: https://developers.zarv.com/api/decision-engine/webhook
- Í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

O spec OpenAPI acima é a fonte da verdade para rotas, parâmetros e schemas — confira nele antes de escrever qualquer request. A decisão final chega por webhook, não pela resposta da chamada que cria a verificação.

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.: enviar uma verificação e consumir o webhook de conclusão]

Consultar lista restritiva​

GET
/api/v2/blacklist

Obtém os registros da lista restritiva com paginação por workspace

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Parameters​

Query Parameters

workspaceId*
Type
string
Required
Example"fc31805a-9ac5-423b-b3cb-b626c769b27c"
Format
"uuid"
limit
Type
integer
Example10
Minimum
1
Maximum
100
page
Type
integer
Example1
Minimum
1

Responses​

Lista restritiva consultada com sucesso

application/json
JSON
{
  
"blacklist": [
  
  
{
  
  
  
"id": "53190a88-7866-4fc4-9986-5e24f7d8da97",
  
  
  
"workspaceId": "fc31805a-9ac5-423b-b3cb-b626c769b27c",
  
  
  
"userId": "a7e3545c-b7e1-4156-8363-7d3ecca8c8d9",
  
  
  
"nationalId": "91439362025",
  
  
  
"type": "FRAUD",
  
  
  
"description": "Fraude",
  
  
  
"createdAt": "2026-03-30T17:53:52Z"
  
  
}
  
],
  
"page": 1,
  
"limit": 10,
  
"total": 1
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI