Pular para o conteúdo principal

Exame Toxicológico para Carteira de Habilitação

Modelo na Plataforma

Sigla: ETCNH

Descrição: Exame Toxicológico para Carteira de Habilitação

Modelo Via API

Type: 15

Este modelo extrai informações-chave de um Exame Toxicológico para Carteira de Habilitação (ETCNH), como dados do funcionário, da empresa, tipo de exame e aptidão para o trabalho.

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 15 para TOXICOLOGICO.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/atestado.pdf" -F "type=15" -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": 15,
"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": 15,
"data": {
"cpf": "000.000.000-00",
"nome": "Fulano da Silva",
"data_da_coleta": "01/02/2022",
"assinado": "NÃO",
"assinatura_info": "Array",
"resultado": "['Negativo']",
"lista_de_substancias": "Array",
"possui_lista_de_substancias": "SIM"
},
"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: Exame Toxicológico para Carteira de Habilitação

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

CampoTipoDescrição
cpfStringCPF
nomeStringNome
dataDaColetaStringData da coleta
assinadoStringAssinado
assinaturaInfoArrayAssinatura
resultadoArrayResultado
listaDeSubstanciasArrayLista de substâncias
possuiListaDeSubstanciasStringPossui lista de substâncias