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/post-api-v2-verifications
- 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]

Criar uma verificação​

POST
/api/v2/verifications

Cria uma nova verificação para um CPF ou CNPJ

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"nationalId": "11111111111",
  
"profileId": "22222222-0000-0000-0000-000000000001",
  
"input": [
  
  
{
  
  
  
"attribute": "renda_declarada",
  
  
  
"value": "5000"
  
  
}
  
],
  
"verifications": {
  
  
"ia": {
  
  
  
"resume": true
  
  
},
  
  
"finance": {
  
  
  
"restrictions": true,
  
  
  
"advanced": true
  
  
},
  
  
"faceRecognition": {
  
  
  
"imageURL": "string",
  
  
  
"filename": "string"
  
  
},
  
  
"cnh": {
  
  
  
"imageURL": "string",
  
  
  
"imageBase64": "string"
  
  
},
  
  
"source": "API",
  
  
"force": false,
  
  
"modules": [
  
  
  
{
  
  
  
  
"name": "lawsuits",
  
  
  
  
"enabled": true
  
  
  
}
  
  
]
  
}
}

Responses​

Verificação criada com sucesso

application/json
JSON
{
  
"id": "string",
  
"workspaceId": "string",
  
"userId": "string",
  
"profileId": "string",
  
"nationalId": "string",
  
"status": "string",
  
"verifications": {
  
  
"type": "string",
  
  
"entity": "string",
  
  
"ia": {
  
  
},
  
  
"finance": "string",
  
  
"faceRecognition": "string",
  
  
"cnh": "string",
  
  
"source": "string",
  
  
"profileId": "string"
  
},
  
"createdAt": "string",
  
"updatedAt": "string"
}

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI