Skip to main content
PATCH
Update Phone

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 profile phone payload

code
string
required

OTP code

Required string length: 6
Example:

"482910"

otpId
string<uuid>
required

OTP identifier

Example:

"01961f5a-7b3c-7a6e-b9d0-4a2e8c1f3d5b"

phoneDdi
string
required

International dialing code

Example:

"55"

phoneIso
string
required

Phone ISO country code

Example:

"BR"

phoneNumber
string
required

Phone number without country code

Example:

"99999999999"

Response

OK

Profile

userId
string<uuid>
required

User identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

scope
object
required

Profile scope

name
string
required

Full name

Example:

"Maria Silva"

emailVerified
boolean
required

Email verified

Example:

false

phoneIso
any
required

Phone ISO country code

Example:

"BR"

phoneDdi
any
required

International dialing code

Example:

"55"

phoneNumber
any
required

Phone number without country code

Example:

"99999999999"

phoneVerified
boolean
required

Phone verified

Example:

false

status
enum<string>
required

User status

Available options:
PENDING,
ACTIVE,
BLOCKED
Example:

"ACTIVE"

createdAt
string<date-time>
required

Created at

Example:

"2025-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2025-01-01T00:00:00.000Z"

googleProviderId
string | null

Google OAuth provider identifier

Example:

"109876543210987654321"

email
any | null

Email address

Example:

"maria@example.com"

avatar
string | null

Avatar object key

Example:

"users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png"

document
any | null

Identification document number

Example:

null

documentType
enum<string> | null

Document type

Available options:
CPF,
CNPJ,
RG
Example:

null

createdBy
string<uuid> | null

Created by

Example:

null

updatedBy
string<uuid> | null

Updated by

Example:

null

birthDate
string<date-time> | null

Date of birth

Example:

"1990-05-15T00:00:00.000Z"