Infrações - Reconhecimento

A API de Reconhecimento permite que o proprietário do veículo (company ou user) assuma o cometimento de uma infração no SNE (Sistema de Notificação Eletrônica). O reconhecimento habilita o desconto de 40% na guia de pagamento.

O processamento é assíncrono: a requisição inicia a tarefa e o status é atualizado na própria infração. Acompanhe o resultado no detalhe da infração ou no webhook traffic-violation.updated.

Propriedades

Name

status

Type

enum

Description

Status do reconhecimento. Na resposta imediata do POST é sempre pending.

Valor	Descrição
`none`	Nenhum reconhecimento foi solicitado.
`pending`	Reconhecimento solicitado e ainda em processamento.
`recognized`	Cometimento reconhecido no SNE.
`failed`	O SENATRAN recusou o reconhecimento ou o portal não está oferecendo a ação.

Name
status_reason
Type
string | null
Description
Motivo da falha, preenchido quando status for failed.
Name
recognized_at
Type
string | null
Description
Data e hora em que o reconhecimento foi confirmado, no formato ISO-8601. null enquanto o processamento não concluir.
Name
availability
Type
boolean
Description
Indica se o reconhecimento da infração está disponível no SNE.

POST/v1/traffic-violations/{id}/recognition

Reconhecer Infração

Inicia o reconhecimento do cometimento da infração no SNE. O proprietário do veículo assume a infração e, quando o processamento concluir com sucesso, o desconto de 40% passa a ficar disponível na guia de pagamento.

O processamento ocorre de forma assíncrona. O campo recognition.status da infração começa como pending e é atualizado para recognized ou failed.

Regras de Validação

recognition.availability deve ser true (retorna 422 caso contrário).
recognition.status deve ser none ou failed (retorna 409 se for recognized ou pending).
A infração precisa estar vinculada a uma company ou a um user (retorna 422 caso contrário).

Parâmetros de Rota

Name
id
Type
number
Required
obrigatório
Description
ID da infração de trânsito.

Request

POST

/v1/traffic-violations/{id}/recognition

curl -X POST https://api.habilitar.me/v1/traffic-violations/1/recognition \
  -H "x-api-key: {token}"

Response - 202

{
  "data": {
    "status": "pending",
    "status_reason": null,
    "recognized_at": null,
    "availability": true
  }
}

Response - 404

{
  "error": "Not Found",
  "message": "Traffic violation with id 123 not found"
}

Response - 409

{
  "error": "Conflict",
  "message": "traffic violation is already recognized"
}

Response - 422

{
  "error": "Unprocessable Entity",
  "message": "traffic violation is not available for recognition"
}