Pular para o conteúdo principal

Certificado de Inspeção Veicular (Novo)

Modelo na Plataforma

Sigla: CIV

Descrição: Certificado de Inspeção Veicular (Novo)

Modelo Via API

Type: 50

Este modelo extrai informações-chave de um Certificado de Inspeção Veicular (Novo) (CIV).

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 50 para CIV_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=50" \
-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": 50,
"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": 50,
"data": {
"id": "20474832000121",
"owner": "MACHADO TRANSPORTADORA E LOGISTICA EIRELLI",
"chassis": "9BSP8X200G3889232",
"issue_date": "2021-02-10",
"license_plate": "ABC1D23",
"document_number": "A7654321",
"expiration_date": "2022-02-10",
"inspection_date": "2021-02-10",
"manufacture_year": "2020",
"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 Inspeção Veicular (Novo)​

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

CampoTipoDescriçãoExemplo
idStringid"20474832000121"
ownerStringowner"MACHADO TRANSPORTADORA E LOGISTICA EIRELLI"
chassisStringchassis"9BSP8X200G3889232"
issueDateStringissue_date"2021-02-10"
licensePlateStringlicense_plate"ABC1D23"
documentNumberStringdocument_number"A7654321"
expirationDateStringexpiration_date"2022-02-10"
inspectionDateStringinspection_date"2021-02-10"
manufactureYearStringmanufacture_year"2020"
documentValidationBooleandocument_validation""