Skip to main content
POST
Cadastrar veículo

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cpf
string
required

CPF do cidadão (11 dígitos)

Required string length: 11

Body

application/json

Dados do veículo

color
string
required
display_name
string
required
has_invoice
boolean
required
self_declaration
boolean
required
serial_number
string
required
serial_number_photo_url
string
required
vehicle_photo_url
string
required
brand_id
string | null
brand_other
string | null
invoice_photo_file_name
string
invoice_photo_file_size
integer
invoice_photo_url
string | null
model_id
string | null
model_other
string | null
serial_number_photo_file_name
string
serial_number_photo_file_size
integer
vehicle_photo_file_name
string
vehicle_photo_file_size
integer
vehicle_type
enum<string>
Available options:
bicicleta_eletrica,
autopropelido,
ciclomotor

Response

Veículo criado

brand_id
string | null
brand_name
string | null

BrandName is response-only: catalog brand name when brand_id is set and brand_other is empty.

brand_other
string | null
color
string
conductor_id
string
created_at
string
deleted_at
string
display_name
string
has_invoice
boolean
id
string
invoice_photo_file_name
string
invoice_photo_file_size
integer
invoice_photo_url
string | null
model_id
string | null
model_name
string | null

ModelName is response-only: catalog model name when model_id is set and model_other is empty.

model_other
string | null
owner_cpf
string
owner_email
string
owner_name
string
owner_phone
string
registration_number
string

RegistrationNumber is a short wallet identifier generated on create (format RJ-E-XXXXXX). Not accepted in POST/PATCH.

Example:

"RJ-E-000001"

role
enum<string>
Available options:
owner,
conductor
self_declaration
boolean
serial_number
string
serial_number_photo_file_name
string

Optional file metadata for UI detail (Apêndice A.4).

serial_number_photo_file_size
integer
serial_number_photo_url
string
updated_at
string
vehicle_photo_file_name
string
vehicle_photo_file_size
integer
vehicle_photo_url
string
vehicle_type
enum<string>
Available options:
bicicleta_eletrica,
autopropelido,
ciclomotor