Skip to main content
PATCH
/
api
/
v1
/
driver
/
profile
Update Profile
curl --request PATCH \
  --url https://api.example.com/api/v1/driver/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Maria Silva",
  "avatar": "users/0197a808/avatar/avatar.png",
  "document": "36641876870",
  "documentType": "CPF",
  "birthDate": "1990-05-15",
  "licenseNumber": "12345678901",
  "licenseCategory": "D",
  "licenseExpiresAt": "2029-05-20"
}
'
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "googleProviderId": "<string>",
  "scope": {
    "permissionIds": [
      "<string>"
    ],
    "organization": {
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "role": {
      "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  },
  "name": "<string>",
  "email": "<string>",
  "emailVerified": true,
  "avatar": "<string>",
  "document": "<string>",
  "birthDate": "2023-12-25",
  "phoneIso": "<string>",
  "phoneDdi": "<string>",
  "phoneNumber": "<string>",
  "phoneVerified": true,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Update driver profile payload.

​
name
string

Full name.

Example:

"Maria Silva"

​
avatar
string | null

Avatar object key.

Example:

"users/0197a808/avatar/avatar.png"

​
document
string | null

Identification document number.

Example:

"36641876870"

​
documentType
enum<string> | null

Document type.

Available options:
CPF,
CNPJ,
RG
Example:

"CPF"

​
birthDate
string<date> | null

Date of birth.

Example:

"1990-05-15"

​
licenseNumber
string

Driver license number.

Example:

"12345678901"

​
licenseCategory
enum<string>

Driver license category.

Available options:
D,
E
Example:

"D"

​
licenseExpiresAt
string<date>

Driver license expiration date.

Example:

"2029-05-20"

Response

OK

Visão consolidada do usuário autenticado — identidade, dados de passageiro e escopo de acesso

​
userId
string<uuid>
required

Identificador do usuário

​
googleProviderId
string | null
required

ID do provedor Google OAuth

​
scope
object
required

Escopo de organização, role e permissões

​
name
string
required

Nome completo

​
email
string | null
required

Email

​
emailVerified
boolean
required

Email verificado

​
avatar
string | null
required

Referência ao avatar

​
document
string | null
required

Número do documento

​
documentType
enum<string> | null
required

Tipo do documento

Available options:
CPF,
CNPJ,
RG
​
birthDate
string<date> | null
required

Data de nascimento

​
phoneIso
string
required

Código ISO do país do telefone

​
phoneDdi
string
required

DDI do telefone

​
phoneNumber
string
required

Número do telefone

​
phoneVerified
boolean
required

Telefone verificado

​
status
enum<string>
required

Status da conta

Available options:
PENDING,
ACTIVE,
BLOCKED
​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização