Habilitar.me

Processos

A API de Processos cobre processos administrativos (por exemplo, suspensão ou cassação de CNH) vinculados à organização.

Use esta página para listar e consultar processos já persistidos. Para protocolar ou acompanhar um recurso (defesa prévia, JARI, CETRAN), veja Recursos.

Propriedades

  • Name
    id
    Type
    integer
    Description

    ID do processo na habilitar.me.

  • Name
    process
    Type
    string
    Description

    Número ou protocolo do processo no órgão (ex.: 12345/2024).

  • Name
    name
    Type
    string | null
    Description

    Nome associado ao processo. Pode ser null.

  • Name
    auto
    Type
    string | null
    Description

    Identificador do auto ou AIT relacionado. Pode ser null.

  • Name
    ordinance
    Type
    string | null
    Description

    Portaria ou ato administrativo vinculado. Pode ser null.

  • Name
    period
    Type
    string | null
    Description

    Período informado pelo órgão. Pode ser null.

  • Name
    article
    Type
    string | null
    Description

    Artigo ou enquadramento. Pode ser null.

  • Name
    context
    Type
    string | null
    Description

    Contexto adicional retornado pelo órgão. Pode ser null.

GET/v1/administrative-procedures

Listar Processos

Lista os processos administrativos da organização autenticada.

Parâmetros opcionais

  • Name
    pagination[page]
    Type
    integer
    Description

    Número da página (a partir de 1). Use com pagination[size].

  • Name
    pagination[size]
    Type
    integer
    Description

    Itens por página (máx. 100). Use com pagination[page].

  • Name
    pagination[start]
    Type
    integer
    Description

    Offset (a partir de 0). Use com pagination[limit]. Não misture com page/size.

  • Name
    pagination[limit]
    Type
    integer
    Description

    Limite de itens no modo offset (máx. 100).

Request

GET
/v1/administrative-procedures
curl -G https://api.habilitar.me/v1/administrative-procedures \
  -H "x-api-key: {api_key}" \
  -d "pagination[page]=1" \
  -d "pagination[size]=10"

Response

{
  "data": [
    {
      "id": 1,
      "process": "12345/2024",
      "name": null,
      "auto": null,
      "ordinance": null,
      "period": null,
      "article": null,
      "context": null
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "total": 1
  },
  "total": 1
}
GET/v1/administrative-procedures/:id

Detalhes do Processo

Retorna um processo administrativo pelo ID.

Request

GET
/v1/administrative-procedures/1
curl https://api.habilitar.me/v1/administrative-procedures/1 \
  -H "x-api-key: {api_key}"

Response

{
  "data": {
    "id": 1,
    "process": "12345/2024",
    "name": null,
    "auto": null,
    "ordinance": null,
    "period": null,
    "article": null,
    "context": null
  }
}

DETRAN-SP

Endpoints de automação no portal DETRAN-SP, com sessão gov.br já existente. Cada POST dispara a task correspondente no senatran e responde 202 com runId e taskId.

Incluído: consulta de processo administrativo, preenchimento de recurso administrativo, recurso JARI/multa e cópia de AIT. Login e sessão manual do gov.br ficam fora desta API: a sessão precisa existir antes da chamada.

O fluxo típico de CNH administrativa é consultar o processo, usar o caseNumber do resultado e então preencher o recurso, sem protocolar. Para o recurso na API, veja Recursos.

POST/v1/procedures/detran-sp/lookup

Consultar processo administrativo

Dispara a consulta no DetranWeb (CNH e reCAPTCHA) via senatran. A API responde 202 só com runId e taskId. O caseNumber e o protocol ficam em appealProbe, no output da run identificada por runId, depois que a task termina.

Corpo

  • Name
    loginId
    Type
    string
    Description

    ID do login gov.br na habilitar.me.

  • Name
    cnh
    Type
    string
    Description

    Número do registro da CNH.

  • Name
    openFirstProcess
    Type
    boolean
    Description

    Se true, tenta abrir o detalhe do primeiro processo.

  • Name
    holdBrowser
    Type
    boolean
    Description

    Padrão false. Se true, mantém o navegador aberto até o wait token.

Request

POST
/v1/procedures/detran-sp/lookup
curl https://api.habilitar.me/v1/procedures/detran-sp/lookup \
  -H "x-api-key: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "loginId": "{login_id}",
    "cnh": "{cnh}",
    "openFirstProcess": true,
    "holdBrowser": false
  }'

Response 202

{
  "runId": "run_...",
  "taskId": "detran-sp-lookup-administrative-process"
}
POST/v1/procedures/detran-sp/issue-appeal

Preencher recurso administrativo

Abre o catálogo de defesa ou recurso de suspensão ou cassação e preenche CNH e processo. Não protocola (submit permanece false).

Use o caseNumber ou o protocol de appealProbe, no output da run da consulta. Esses campos não vêm no corpo 202.

Corpo

  • Name
    loginId
    Type
    string
    Description

    ID do login gov.br na habilitar.me.

  • Name
    cnh
    Type
    string
    Description

    Número do registro da CNH.

  • Name
    caseNumber
    Type
    string
    Description

    Processo administrativo (ex.: 12345/2024). Alias: protocol.

  • Name
    holdBrowser
    Type
    boolean
    Description

    Padrão false.

  • Name
    submit
    Type
    boolean
    Description

    Reservado. Sempre false.

Request

POST
/v1/procedures/detran-sp/issue-appeal
curl https://api.habilitar.me/v1/procedures/detran-sp/issue-appeal \
  -H "x-api-key: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "loginId": "{login_id}",
    "cnh": "{cnh}",
    "caseNumber": "12345/2024",
    "holdBrowser": false,
    "submit": false
  }'

Response 202

{
  "runId": "run_...",
  "taskId": "detran-sp-issue-appeal-administrative-process"
}
POST/v1/procedures/detran-sp/issue-appeal-traffic-violation

Recurso JARI / multa

Fluxo de recurso de multa (Renavam e reCAPTCHA no DetranWeb). Task: detran-sp-issue-appeal-traffic-violation.

Corpo

  • Name
    loginId
    Type
    string
    Description

    ID do login gov.br na habilitar.me.

  • Name
    renavam
    Type
    string
    Description

    RENAVAM do veículo.

  • Name
    holdBrowser
    Type
    boolean
    Description

    Padrão false.

  • Name
    captchaTimeoutMs
    Type
    integer
    Description

    Timeout opcional para o reCAPTCHA, em milissegundos.

Request

POST
/v1/procedures/detran-sp/issue-appeal-traffic-violation
curl https://api.habilitar.me/v1/procedures/detran-sp/issue-appeal-traffic-violation \
  -H "x-api-key: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "loginId": "{login_id}",
    "renavam": "12345678901",
    "holdBrowser": false
  }'

Response 202

{
  "runId": "run_...",
  "taskId": "detran-sp-issue-appeal-traffic-violation"
}
POST/v1/procedures/detran-sp/request-ait-copy

Solicitar cópia do AIT

Preenche o formulário de cópia do auto de infração. Não protocola. Task: detran-sp-request-ait-copy.

Corpo

  • Name
    loginId
    Type
    string
    Description

    ID do login gov.br na habilitar.me.

  • Name
    placa
    Type
    string
    Description

    Placa do veículo.

  • Name
    ait
    Type
    string
    Description

    Número do AIT.

  • Name
    renavam
    Type
    string
    Description

    RENAVAM opcional.

  • Name
    holdBrowser
    Type
    boolean
    Description

    Padrão false.

Request

POST
/v1/procedures/detran-sp/request-ait-copy
curl https://api.habilitar.me/v1/procedures/detran-sp/request-ait-copy \
  -H "x-api-key: {api_key}" \
  -H "Content-Type: application/json" \
  -d '{
    "loginId": "{login_id}",
    "placa": "ABC1D23",
    "ait": "A1B234567",
    "holdBrowser": false,
    "submit": false
  }'

Response 202

{
  "runId": "run_...",
  "taskId": "detran-sp-request-ait-copy"
}

Essa página foi útil?