platestringRequiredpattern"^[A-Z]{3}[0-9][A-Z0-9][0-9]{2}$"← HomeFleetPay / API
Register a vehicle
Parameters, data structure and responses from the versioned contract.
POST
/fiscal/veiculosTechnical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.
Authentication
[
{
"oauth2": []
},
{
"chaveApi": []
}
]Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.
Parameters
No parameters declared for this operation.
Request Body
Required
application/json
plate_statestring | nullOptionalminLength2maxLength2renavamstring | nullOptionalpattern"^\\d{11}$"tare_kgnumber | nullOptionalminimum0capacity_kgnumber | nullOptionalminimum0capacity_m3number | nullOptionalminimum0axlesnumber | nullOptionalminimum0maximum255body_typenumber | nullOptionalminimum0maximum255wheel_typenumber | nullOptionalminimum0maximum255owner_typestring | nullOptional"own" · "third"owner_documentstring | nullOptionalmaxLength14owner_namestring | nullOptionalmaxLength120owner_rntrcstring | nullOptionalmaxLength8default_driver_user_idinteger | nullOptionalminimum1Responses
201 HTTP Response
Vehicle registered.
Headers
X-Request-IdCall correlation identifier.
401 HTTP Response
FleetPay API key missing or invalid.
Headers
X-Request-IdCall correlation identifier.
403 HTTP Response
Fiscal scope disabled for the key, or no active carrier associated with the key.
Headers
X-Request-IdCall correlation identifier.
422 HTTP Response
Invalid payload, outstanding requirement or business rule.
Headers
X-Request-IdCall correlation identifier.
429 HTTP Response
Per-carrier limit exceeded.
Headers
X-Request-IdCall correlation identifier.
Retry-AfterSeconds until another attempt.
500 HTTP Response
Internal failure without operational integration details.
Headers
X-Request-IdCall correlation identifier.
Complete Operation Definition
{
"tags": [
"Veículos"
],
"summary": "Cadastrar veículo",
"operationId": "createVehicle",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VehicleCreateInput"
}
}
}
},
"responses": {
"201": {
"$ref": "#/components/responses/VehicleCreated"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"422": {
"$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
}
},
"method": "POST",
"path": "/fiscal/veiculos",
"parameters": []
}