Documentação

Primeira Chamada

Sua primeira chamada à API do começo ao fim: autenticar, pedir um relatório, acompanhar o processamento e ler o resultado no payload.

Pré-requisitos

  • Organização com API habilitada pelo time Minha CNH.
  • API key gerada em Configurações → API.
  • (Opcional) Webhook configurado para receber o resultado.

Criar um relatório

curl -X POST "https://minhacnh.doutormultas.com.br/api/v1/reports" \
  -H "Authorization: Bearer cnh_live_<prefix>_<secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "cpf": "123.456.789-09",
    "externalRef": "driver-42"
  }'

Resposta 202 Accepted:

{
  "reportId": "clxyz...",
  "status": "PROCESSING",
  "driver": {
    "id": "cldrv...",
    "cpf": "123.456.789-09",
    "name": "João Silva",
    "licenseNumber": "12345678901",
    "licenseCategory": "AB",
    "expiryDate": "2028-05-10T00:00:00.000Z",
    "issueState": "SP"
  },
  "statusUrl": "/api/v1/reports/clxyz...",
  "webhookConfigured": true,
  "estimatedDeliveryAt": "2026-06-01T12:05:00Z"
}

O `202` confirma o condutor; o relatório vem depois

O bloco driver já vem identificado, então o 202 serve para conferir que o CPF resolveu para a pessoa certa. O diagnóstico é assíncrono e chega via webhook ou por polling no statusUrl — a entrega leva cerca de 3 minutos na mediana, e a cauda é bem mais longa que isso.

Receber o resultado (polling)

curl "https://minhacnh.doutormultas.com.br/api/v1/reports/clxyz..." \
  -H "Authorization: Bearer cnh_live_<prefix>_<secret>"

Quando status === "DELIVERED" o campo diagnosis contém o diagnóstico completo. Ver Shape do Payload para a lista completa de campos.

Próximos passos