Documentação

Changelog

Histórico de versões da API Minha CNH. Mudanças breaking são comunicadas com antecedência mínima de 30 dias.

Política de versionamento

Mudanças não-breaking (novos campos opcionais, novos eventos de webhook) não incrementam a versão principal. Mudanças breaking são comunicadas por e-mail aos administradores das organizações com pelo menos 30 dias de antecedência.

2026-07-23 — Análise por IA automática no fluxo B2B

  • A partir de agora, o campo aiAnalysis é gerado automaticamente para relatórios criados via API/MCP — não é mais necessário falar com o suporte para habilitá-la.
  • Não-breaking: o campo já era opcional e anulável. Continua null durante PROCESSING e pode vir null num relatório entregue caso a geração falhe (é best-effort e nunca bloqueia a entrega).
  • Garantia de ordem: quando presente, a análise é gravada antes de o status virar DELIVERED e antes de o webhook report.delivered ser enfileirado. Ou seja, um relatório entregue com análise a traz de forma idêntica no GET /api/v1/reports/{reportId} e no corpo do webhook.

2026-07-18 — Campo aiAnalysis (análise por IA)

  • Novo campo opcional e anulável aiAnalysis no payload do relatório ({ markdown, status, generatedAt }) — uma análise em linguagem natural gerada por IA a partir do diagnóstico. Aparece em GET /api/v1/reports/{reportId}, no corpo do webhook report.delivered e nas ferramentas MCP get_report / wait_for_report / find_report_by_external_ref (a mesma serialização em todos).
  • Não-breaking: campo adicional opcional — integrações existentes não precisam de nenhuma mudança. É null enquanto o relatório está em PROCESSING. (Na estreia, a geração ficava desativada por padrão no fluxo B2B; desde 2026-07-23 ela é automática — ver a entrada acima.)

2026-07 — Servidor MCP

  • Novo endpoint POST /api/mcp — um servidor Model Context Protocol (JSON-RPC 2.0, stateless) que expõe a API a agentes de IA/chatbots com a mesma API key cnh_live_.
  • 10 ferramentas: request_report, get_report, wait_for_report, find_report_by_external_ref, ask_doutor_multas, get_credit_balance, get_usage, list_reports, lookup_violation_code, calculate_points.
  • Adição não-breaking: os endpoints REST existentes não são afetados; o MCP reutiliza a mesma autenticação, cobrança e rate limits.

2026-06-16 — Novo evento report.partially_delivered

  • Novo evento de webhook report.partially_delivered: enviado quando o relatório é entregue, mas dados complementares do DETRAN do estado ficam pendentes. Se a busca for recuperada depois, um report.delivered é enviado em seguida.
  • Adição não-breaking: o evento é opt-in — selecione-o em Configurações → API para começar a recebê-lo. Webhooks existentes não são afetados.

v1.0 — Lançamento

Endpoints disponíveis:

  • POST /api/v1/reports — criar relatório de CNH (retorna 202 Accepted)
  • GET /api/v1/reports/{reportId} — consultar relatório

Funcionalidades:

  • Autenticação Bearer com formato cnh_live_<prefix>_<secret>
  • Status público do relatório: PROCESSING, DELIVERED, ERROR
  • Webhook HMAC-SHA256 com formato t=<unix>,v1=<hex> (Stripe-style), assinatura recomputada por tentativa
  • Eventos: report.delivered, report.failed
  • Idempotência via externalRef (janela 1h) e proteção de race (janela 60s)
  • Billing pós-pago com débito na criação e estorno automático em falha do pipeline
  • Rate limiting por minuto, por dia e concorrência
  • Log de entregas com retry manual em Configurações → API
  • Garantia anti-leak: payloads brutos do provider nunca são expostos