Skip to main content
PATCH
Update a User's Name

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

user_id
string<uuid>
required

The unique ID of the user whose identity you want to update.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Body

application/json

Update a user's name on the platform.

Every field is optional; send only what you want to change. Only the name is touched — email, status, wallets, and the individual/business type are left untouched (the type is fixed at creation). For an individual, update first_name/last_name; for a business, update business_name. If the user has already passed identity verification, a changed name must match the verified name on file (case-insensitive) or the request is rejected.

first_name
string | null

User's given name (individuals only).

Maximum string length: 100
Example:

"John"

last_name
string | null

User's family name (individuals only).

Maximum string length: 100
Example:

"Doe"

business_name
string | null

Organization name (business users only).

Maximum string length: 100
Example:

"Acme Corporation"

Response

The user with its updated name.

status_code
integer
required

HTTP status code for the response.

data
PlatformUserRead · object
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.