Carteira Nacional de Habilitação

A API de CNHs permite listar e obter detalhes das Carteiras Nacionais de Habilitação conectadas à sua organização. Para que as informações da CNH estejam disponíveis, é necessário que o usuário tenha sido autenticado através do widget de login.

Propriedades

Name
id
Type
number
Description
ID único da CNH.
Name
license
Type
string
Description
Número de registro da CNH.
Name
name
Type
string
Description
Nome completo do(a) condutor(a).
Name
tax_id
Type
string
Description
CPF do(a) condutor(a) no formato XXXXXXXXXXX.
Name
points
Type
number
Description
Pontuação atual da CNH (número de pontos acumulados por infrações).
Name
status
Type
string
Description
Status atual da CNH. Valores possíveis:
Valor Descrição
Válida CNH válida e ativa
Expirada CNH com validade vencida
Suspensa CNH suspensa temporariamente
Cancelada CNH cancelada definitivamente
Name
issue_date
Type
string
Description
Data de emissão da CNH no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
Name
expiration_date
Type
string
Description
Data de validade da CNH no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).
Name
created_at
Type
string
Description
Data e hora em que a CNH foi registrada em nosso sistema no formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ).

Valor	Descrição
`Válida`	CNH válida e ativa
`Expirada`	CNH com validade vencida
`Suspensa`	CNH suspensa temporariamente
`Cancelada`	CNH cancelada definitivamente

GET/v1/driver-licenses/

Listar CNHs

Retorna uma lista paginada de todas as CNHs.

Parâmetros de Paginação

Name
pagination[page]
Type
integer
Description
Número da página (começando em 1). Use junto com pagination[size].
Name
pagination[size]
Type
integer
Description
Tamanho da página (número de itens por página, máximo 100). Use junto com pagination[page].

Request

GET

/v1/driver-licenses/

curl -G https://api.habilitar.me/v1/driver-licenses/ \
  -H "x-api-key: {token}" \
  -d "pagination[page]=1" \
  -d "pagination[size]=10"

Response

{
  "data": [
    {
      "id": 1,
      "license": "12345678900",
      "name": "João da Silva",
      "tax_id": "12345678900",
      "points": 12,
      "status": "Válida",
      "issue_date": "2022-05-10T00:00:00Z",
      "expiration_date": "2032-05-10T00:00:00Z",
      "created_at": "2024-01-01T00:00:00Z"
    },
    {
      "id": 2,
      "license": "98765432100",
      "name": "Maria Oliveira",
      "tax_id": "98765432100",
      "points": 0,
      "status": "Válida",
      "issue_date": "2020-03-15T00:00:00Z",
      "expiration_date": "2030-03-15T00:00:00Z",
      "created_at": "2024-01-15T00:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10
  },
  "total": 2
}

GET/v1/driver-licenses/{id}

Detalhar CNH - id

Retorna os detalhes completos de uma CNH específica.

Parâmetros de Rota

Name
id
Type
number
Required
obrigatório
Description
ID da CNH que deseja consultar.

Request

GET

/v1/driver-licenses/{id}

curl https://api.habilitar.me/v1/driver-licenses/1 \
  -H "x-api-key: {token}"

Response - 200

{
  "data": {
    "id": 1,
    "license": "12345678900",
    "name": "João da Silva",
    "tax_id": "12345678900",
    "points": 12,
    "status": "Válida",
    "issue_date": "2022-05-10T00:00:00Z",
    "expiration_date": "2032-05-10T00:00:00Z"
  }
}

Response - 404

{
  "error": "CNH não encontrado"
}