Skip to main content

​
Bem-vindo à API Verifica AI

A API Verifica AI oferece uma solução completa para análise de contratos utilizando inteligência artificial. Com esta API, você pode:
  • Gerenciar contratos
  • Fazer upload de contratos (PDF, DOC, DOCX)
  • Realizar análises de risco automatizadas
  • Obter recomendações detalhadas sobre cláusulas contratuais
  • Gerenciar credenciais de API

Especificação OpenAPI

Ver a especificação OpenAPI completa

​
Autenticação

A maioria dos endpoints da API requer autenticação via JWT (JSON Web Token). Apenas os endpoints de Health Check não requerem autenticação.

​
Como obter o token

Faça login através do endpoint /auth/login com suas credenciais: 
curl -X POST https://api.verifica.ia.br/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "senha123456"
  }'
A resposta incluirá um token JWT que você deve usar nas requisições subsequentes.

​
Header de autenticação

Inclua o token no header Authorization de todas as requisições autenticadas: 
Authorization: Bearer SEU_TOKEN_JWT

Ver guia completo de autenticação

Aprenda mais sobre autenticação JWT, códigos de erro e troubleshooting

​
Servidores

A API está disponível em dois ambientes:
  • Produção: https://api.verifica.ia.br
  • Desenvolvimento: http://localhost:3333

​
Estrutura da API

A API está organizada em quatro grupos principais:
Endpoints para verificação de saúde da API
Upload, listagem, atualização e exclusão de contratos
Análise de risco de contratos com IA, incluindo identificação de problemas críticos e recomendações
Geração e verificação de status de credenciais de API

​
Formatos de arquivo suportados

Para upload de contratos, os seguintes formatos são aceitos:
  • PDF: application/pdf
  • DOC: application/msword
  • DOCX: application/vnd.openxmlformats-officedocument.wordprocessingml.document
Tamanho máximo: 10MB

​
Análise de Risco

A análise de risco é processada de forma assíncrona e pode levar alguns minutos para ser concluída. O status da análise pode ser:
  • pending: Análise aguardando processamento
  • in_progress: Análise em andamento
  • completed: Análise concluída com sucesso
  • failed: Análise falhou
Use o endpoint GET /risk-analysis/contracts/{contractId}/analysis para verificar o status e obter os resultados da análise.

​
Códigos de resposta

A API utiliza os seguintes códigos de status HTTP:
  • 200 - Sucesso
  • 201 - Criado com sucesso
  • 400 - Requisição inválida
  • 401 - Não autorizado (token inválido ou ausente)
  • 403 - Proibido (limite de análises atingido)
  • 404 - Recurso não encontrado
  • 500 - Erro interno do servidor