Skip to main content

Carteira Nacional de Habilitação (Novo)

Modelo na Plataforma

Sigla: CNH

Descrição: Carteira Nacional de Habilitação (Novo)

Modelo Via API

Type: 54

Este modelo extrai informações-chave de um Carteira Nacional de Habilitação (Novo) (CNH).

O processo de extração é assíncrono e consiste em dois passos principais:

  1. Enviar o documento para a fila de processamento.
  2. Consultar o resultado após a conclusão do processamento.

Passo 1: Enviar o Documento para Processamento​

Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.

POST URL Ambiente/documents/upload

Headers​

IdentificadorValor
Content-Typemultipart/form-data
IDEXA-API-KEYsua_api_key

Payload (Corpo da Requisição)​

A requisição deve conter os seguintes parâmetros obrigatórios:

ParâmetroDescriçaoTipo
filesO arquivo do documento a ser processado.File
typeCódigo interno do modelo. Use 54 para DRIVER_LICENSE.Integer

Os parâmetros a seguir são opcionais:

ParâmetroDescriçaoTipo
pagesDefine páginas específicas para análise (ex: "1,2,5-10").String
externalIdId externo para seu controle (não pode repetir).String

Exemplos de Requisição​

curl -X POST "URL_BASE/documents/upload" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/seu/documento.pdf" \
-F "type=54" \
-F "externalId=pedido-cliente-123"

Resposta Imediata (Status 200)​

A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.

{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 54,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
Processamento Assíncrono

A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.

Passo 2: Consultar o Resultado​

Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.

GET URL Ambiente/documents/[id]

Resposta Final (Status 200)​

Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.

Exemplo de Resposta Completa
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 54,
"data": {
"name": "FULANO DA SILVA",
"date_of_birth": "1969-08-04",
"issue_date": "2022-07-25",
"expiration_date": "2027-07-23",
"license_number": "00000000000",
"license_class": "AE",
"filiation": "['FULANO DA SILVA', 'FULANA DA SILVA']",
"personal_number": "00000000000",
"place_of_birth": "PORTO ALEGRE/RS",
"place_of_issue": "RS",
"card_issuer": "DETRAN",
"comments": "null",
"has_cetpp": "false",
"document_validation": "True"
},
"processTime": 8.123,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:58.168Z"
}

Dicionário de Dados: Carteira Nacional de Habilitação (Novo)​

Estes são os campos retornados dentro do objeto data.

CampoTipoDescriçãoExemplo
nameStringNome"FULANO DA SILVA"
dateOfBirthStringData de Nascimento"1969-08-04"
issueDateStringData de Emissão"2022-07-25"
expirationDateStringData de Expiração"2027-07-23"
licenseNumberStringNúmero da Licença"00000000000"
licenseClassStringClasse da Licença"AE"
filiation.idNumberStringNúmero de Identidade Nacional"22180118"
filiation.idIssuerStringÓrgão Emissor do ID"SSP"
filiation.stateStringEstado do ID"SP"
personalNumberStringNúmero Pessoal"00000000000"
placeOfBirthStringLocal de Nascimento"PORTO ALEGRE/RS"
placeOfIssueStringLocal de Emissão"RS"
cardIssuerStringEmissor do Cartão"DETRAN"
filiationArrayFilição"['FULANO DA SILVA', 'FULANA DA SILVA']"
commentsStringComentários"null"
hasCetppBooleanPossui CETPP"false"
documentValidationBooleanValidação do Documento"True"