Pular para o conteúdo principal

Certificado de Inspeção para o Transporte de Produtos Perigosos (Novo)

Modelo na Plataforma

Sigla: CIPP

Descrição: Certificado de Inspeção para o Transporte de Produtos Perigosos (Novo)

Modelo Via API

Type: 53

Este modelo extrai informações-chave de um Certificado de Inspeção para o Transporte de Produtos Perigosos (Novo) (CIPP).

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 53 para CIPP_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=53" \
-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": 53,
"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": 53,
"data": {
"renavam": "28090299663",
"next_inspection_date": "2025-06-30",
"report_number": "246628405",
"old_cipp_number": "A756569",
"document_number": "493519",
"inspection_date": "2024-06-30",
"equipment_number": "126969118",
"license_plate": "NCH3274",
"expiration_date": "2025-06-30",
"id": "41159231000120",
"owner": "BARTHON NESPOLI MATERIAL DE CONSTRUÇÃO LTDA",
"chassis": "8JMXA4CYMY2KR8694",
"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 para o Transporte de Produtos Perigosos (Novo)​

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

CampoTipoDescriçãoExemplo
renavamStringRenavam"28090299663"
nextInspectionDateStringNext inspection date"2025-06-30"
reportNumberStringReport number"246628405"
oldCippNumberStringOld CIPP number"A756569"
documentNumberStringDocument number"493519"
inspectionDateStringInspection date"2024-06-30"
equipmentNumberStringEquipment number"126969118"
licensePlateStringLicense plate"NCH3274"
expirationDateStringExpiration date"2025-06-30"
idStringID"41159231000120"
ownerStringOwner"BARTHON NESPOLI MATERIAL DE CONSTRUÇÃO LTDA"
chassisStringChassis"8JMXA4CYMY2KR8694"
documentValidationBooleanDocument Validation"true"