Skip to main content

Queries — Status and History

Query the current status or full history of any request using codigoQiTech.

Query Current Status

ENDPOINT
/v1/vehicles/contracts/status/
METHOD
GET

Scope: vehicles/read

Request

Request Params
FieldTypeDescriptionReq.
codigoQiTechStringUnique request identifier (up to 255 characters)YES

Response (200)

Response Body
FieldTypeDescription
codigoQiTechStringUnique request identifier
etapaAtualStringProcess stage (Lien Registration / Contract Registration / Contract Addendum / Contract Image)
statusStringCurrent process status (see Status Map)
msgRetornoProvedorStringProvider return message (populated on rejection)
msgRetornoPlataformaStringPlatform return message (populated on rejection)
dataUltimaAtualizacaoStringLast update date (YYYY-MM-DD)
chassiStringVehicle VIN
ufDeLicenciamentoStringVehicle licensing state (UF)
numGravameStringLien number (up to 8 chars; "0" if not yet available)

Query History

ENDPOINT
/v1/vehicles/contracts/history/
METHOD
GET

Scope: vehicles/read

Request

Request Params
FieldTypeDescriptionReq.
codigoQiTechStringUnique request identifier (up to 255 characters)YES

Response (200)

Response Body
FieldTypeDescription
codigoQiTechStringUnique request identifier
historicoGarantiaStringDescription of operations performed with date/time for each
msgRetornoProvedorStringProvider return message
msgRetornoPlataformaStringPlatform return message
chassiStringVehicle VIN
ufDeLicenciamentoStringLicensing state (UF)
numGravameStringLien number (up to 8 characters)
Information

For returns "Denied", "Invalid Data", or "Invalid", at least one of msgRetornoPlataforma and msgRetornoProvedor will be populated with the reason.