Documentação
APIConsumir DadosConsultar Relatório

Consultar Relatório

GET /api/v1/reports/{reportId} — polling do status e resultado. Retorna 404 para IDs de outras organizações, sem vazar informação.

Endpoint

GET /api/v1/reports/{reportId}
Authorization: Bearer cnh_live_<prefix>_<secret>

{reportId} é o valor retornado pelo POST /api/v1/reports.

Respostas

200 OK — relatório encontrado

O corpo tem a mesma forma do payload do webhook. Ver Shape do Payload para a tabela completa de campos.

{
  "reportId": "clxyz...",
  "externalRef": "driver-42",
  "status": "DELIVERED",
  "driver": {
    "id": "cldrv...",
    "cpf": "123.456.789-09",
    "name": "João Silva",
    "licenseNumber": "12345678901",
    "licenseCategory": "AB",
    "expiryDate": "2028-05-10",
    "issueState": "SP"
  },
  "diagnosis": { "...": "..." },
  "normalized": { "...": "..." },
  "createdAt": "2026-06-01T12:00:00Z",
  "deliveredAt": "2026-06-01T12:04:30Z"
}

Ciclo de vida do campo status

StatusDescrição
PROCESSINGRelatório enfileirado ou em processamento; diagnosis ainda é null
DELIVEREDDiagnóstico completo disponível em diagnosis
ERRORPipeline falhou após todas as tentativas; crédito estornado

404 Not Found

Retornado quando o reportId não existe ou pertence a outra organização. O 404 é deliberado para não revelar a existência de dados de outro tenant.

{
  "defined": false,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found"
}

Polling recomendado com intervalo

Sondagens mais frequentes do que a cada 30 segundos podem ativar o rate limit. Use webhooks para eliminar a necessidade de polling.