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

Obter resumo por IA da verificação​

GET
/api/v2/verifications/{id}/ai-summary

Retorna o resumo/veredito gerado por IA para uma verificação do motor novo (engine).

Quando o resumo é gerado. A IA NÃO roda em toda verificação. Ela é acionada quando o profile tem IA habilitada — pelo menos um módulo com AIModuleSummaryEnabled=true (o bloco ai do request pode sobrepor a config do profile por execução). Há dois caminhos:

  • Automático: ao concluir o processamento (status COMPLETED, com dados de módulo e sem deferAutopilot), o motor computa e persiste o resumo antes de finalizar.
  • Lazy (sob demanda): este endpoint computa o resumo na primeira chamada e persiste; chamadas seguintes retornam o resultado pronto.

Requer verificação do motor novo (com profileId) já concluída. Para profiles sem IA habilitada o resumo não é gerado.

Authorizations​

Authentication v2

For more details, see Authentication v2

Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses​

Resumo por IA da verificação

application/json
JSON
{
  
"verificationId": "string",
  
"workspaceId": "string",
  
"nationalId": "string",
  
"entityType": "string",
  
"generatedAt": "string",
  
"promptsDurationMs": 0,
  
"modules": {
  
  
"profile": {
  
  
  
"summary": "string",
  
  
  
"confidence": 0,
  
  
  
"highlights": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"autopilot": "string"
  
  
},
  
  
"finance": {
  
  
  
"summary": "string",
  
  
  
"confidence": 0,
  
  
  
"highlights": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"autopilot": "string"
  
  
},
  
  
"lawsuits": {
  
  
  
"summary": "string",
  
  
  
"confidence": 0,
  
  
  
"highlights": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"autopilot": "string"
  
  
},
  
  
"related": {
  
  
  
"personal": {
  
  
  
  
"summary": "string",
  
  
  
  
"confidence": 0,
  
  
  
  
"highlights": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"autopilot": "string"
  
  
  
},
  
  
  
"business": {
  
  
  
  
"summary": "string",
  
  
  
  
"confidence": 0,
  
  
  
  
"highlights": [
  
  
  
  
  
"string"
  
  
  
  
],
  
  
  
  
"autopilot": "string"
  
  
  
}
  
  
}
  
},
  
"finalSummary": {
  
  
"summary": "string",
  
  
"shortDescription": "string",
  
  
"recommendation": "string",
  
  
"keyFactors": [
  
  
  
"string"
  
  
],
  
  
"autopilot": "string"
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI