Skip to main content
POST
Convidar condutor

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
vehicle_id
string
required

ID do veículo

Body

application/json

CPF + e-mail do convidado (name/phone opcionais)

cpf
string
required

CPF must be exactly 11 digits (no punctuation), matching RMI/JWT form.

Example:

"11144477735"

email
string
required
name
string
phone
string

Response

Convite criado

conductor_cpf
string
conductor_name
string

Invite snapshot (persisted). For accepted links, GET overlays live RMI contact on these JSON fields.

created_at
string
email_attempted_at
string
email_status
enum<string>

Invite email delivery (handoff: register attempt/status on the link).

Available options:
pending,
queued,
sent,
failed,
skipped
id
string
invited_by_cpf
string
notify_email
string
phone
string
responded_at
string
status
enum<string>
Available options:
pending,
accepted,
rejected,
revoked
updated_at
string
vehicle_id
string