Pular para o conteúdo principal

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).

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 52 para CVT_CERTIFICATE.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=52" \
-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": 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.

CampoTipoDescriçãoExemplo
nameStringName"TRANSPORTES EXEMPLO LTDA"
addressStringAddress"RUA EXEMPLO - QD. 02 LT. 05"
cityStringCity"CIDADE EXEMPLO"
stateStringState"SP"
idStringId"12345678000195"
cepStringCEP"12345678"
verificationDateStringVerification date"2022-01-15"
certificateNumberStringCertificate number"9876543"
brandStringBrand"MARCA EXEMPLO"
inmetroNumberStringInmetro number"L12345"
manufactureYearStringManufacture year"2020"
compartmentsStringCompartments"2"
capacityStringCapacity"25.000"
expirationDateStringExpiration date"2025-01-14"
capacityLevelObjectCapacity level"{'c1_n1': '20000', 'c1_n2': '18000', 'c1_n3': '17000'}"
typeStringType"MULTI SETA"
licensePlateStringLicense plate"ABC1234"
chassisStringChassis"1HGBH41JXMN109186"
noteStringNote"A VERIFICAÇÃO FOI REALIZADA COM SUCESSO."
documentValidationBooleanDocument Validation"true"