Certificado de Verificação de Veículo Tanque Rodoviário (Novo)

Modelo na Plataforma

Sigla: CVT

Descrição: Certificado de Verificação de Veículo Tanque Rodoviário (Novo)

Modelo Via API

Type: 52

Este modelo extrai informações-chave de um Certificado de Verificação de Veículo Tanque Rodoviário (Novo) (CVT), 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

Identificador	Valor
Content-Type	multipart/form-data
IDEXA-API-KEY	sua_api_key

Payload (Corpo da Requisição)

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

Parâmetro	Descriçao	Tipo
files	O arquivo do documento a ser processado.	File
type	Código interno do modelo. Use 52 para CVT_CERTIFICATE.	Integer

Os parâmetros a seguir são opcionais:

Parâmetro	Descriçao	Tipo
pages	Define páginas específicas para análise (ex: "1,2,5-10").	String
externalId	Id externo para seu controle (não pode repetir).	String

Exemplos de Requisição

cURL

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=52" -F "externalId=pedido-cliente-123"

JavaScript

const myHeaders = new Headers();
myHeaders.append("IDEXA-API-KEY", "sua_api_key");

const formdata = new FormData();
formdata.append("files", fileInput.files[0], "atestado.pdf");
formdata.append("type", "52");
formdata.append("externalId", "pedido-cliente-123");

const requestOptions = { method: 'POST', headers: myHeaders, body: formdata };

fetch("URL_BASE/documents/upload", requestOptions)
  .then(response => response.json())
  .then(result => console.log(result));

Python

import requests

url = "URL_BASE/documents/upload"
payload = {'type': '52', 'externalId': 'pedido-123'}
files=[('files',('atestado.pdf',open('/path/to/atestado.pdf','rb'),'application/pdf'))]
headers = {'IDEXA-API-KEY': 'sua_api_key'}

response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.json())

PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, [
  CURLOPT_URL => "URL_BASE/documents/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => [
    'files' => new CURLFile('/path/to/atestado.pdf'),
    'type' => '52',
    'externalId' => 'pedido-cliente-123'
  ],
  CURLOPT_HTTPHEADER => [
    "IDEXA-API-KEY: sua_api_key"
  ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;

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": 52,
  "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": 52,
  "data": {
    "name": "TRANSPORTES EXEMPLO LTDA",
    "address": "RUA EXEMPLO - QD. 02 LT. 05",
    "city": "CIDADE EXEMPLO",
    "state": "SP",
    "id": "12345678000195",
    "cep": "12345678",
    "verification_date": "2022-01-15",
    "certificate_number": "9876543",
    "brand": "MARCA EXEMPLO",
    "inmetro_number": "L12345",
    "manufacture_year": "2020",
    "compartments": "2",
    "capacity": "25.000",
    "expiration_date": "2025-01-14",
    "capacity_level": "{'c1_n1': '20000', 'c1_n2': '18000', 'c1_n3': '17000'}",
    "type": "MULTI SETA",
    "license_plate": "ABC1234",
    "chassis": "1HGBH41JXMN109186",
    "note": "A VERIFICAÇÃO FOI REALIZADA COM SUCESSO.",
    "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: Certificado de Verificação de Veículo Tanque Rodoviário (Novo)

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

Campo	Tipo	Descrição
name	String	Name
address	String	Address
city	String	City
state	String	State
id	String	Id
cep	String	CEP
verificationDate	String	Verification date
certificateNumber	String	Certificate number
brand	String	Brand
inmetroNumber	String	Inmetro number
manufactureYear	String	Manufacture year
compartments	String	Compartments
capacity	String	Capacity
expirationDate	String	Expiration date
capacityLevel	Object	Capacity level
type	String	Type
licensePlate	String	License plate
chassis	String	Chassis
note	String	Note
documentValidation	Boolean	Document Validation