Skip to main content
PATCH
Update a user

Authorizations

Api-Key
string
header
required

Path Parameters

userId
string<uuid>
required

Id of the user to update

Body

application/json

The updates to apply to the user

firstName
string

The user's first name

Maximum string length: 50
lastName
string

The user's last name

Maximum string length: 50
email
string

The user's email address

isActive
boolean

Whether the user is active

address
object

The user's physical address

phoneCountryCode
string

The user's phone country code

Required string length: 1 - 3
Pattern: ^[0-9]+$
Example:

"1"

phoneNumber
string

The user's phone number

Required string length: 1 - 15
Pattern: ^[0-9]+$
Example:

"5555555555"

walletAddress
string

This user's EVM wallet address. For self-managed tenants, cannot be updated if the user has collateral contracts on EVM chains. For Rain-managed tenants, the update is allowed if the new wallet is already an on-chain admin on all of the team's EVM collateral contracts.

Pattern: ^0x[0-9a-fA-F]{40}$
solanaAddress
string

This user's solana address. Cannot be updated if the user has collateral contracts on Solana.

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
stellarAddress
string

This user's stellar address. Cannot be updated if the user has collateral contracts on Stellar.

Pattern: ^[GC][A-Z2-7]{55}$|^M[A-Z2-7]{68}$
externalId
string

An optional tenant-defined identifier for this user. Must be unique within the tenant.

Required string length: 1 - 255

Response

Successful operation

id
string<uuid>
required

The user's unique identifier

firstName
string
required

The user's first name

Maximum string length: 50
lastName
string
required

The user's last name

Maximum string length: 50
email
string
required

The user's email address

isActive
boolean
required

Whether the user is active

applicationStatus
enum<string>
required
Available options:
approved,
pending,
needsInformation,
needsVerification,
manualReview,
denied,
locked,
canceled
companyId
string<uuid>

The id of the company that the user belongs to, if any

externalId
string

An optional tenant-defined identifier for this user. Must be unique within the tenant.

Required string length: 1 - 255
sourceKey
string

The source key associated with the user's team

Required string length: 1 - 24
address
object

The user's physical address

phoneCountryCode
string

The user's phone country code

Required string length: 1 - 3
Pattern: ^[0-9]+$
Example:

"1"

phoneNumber
string

The user's phone number

Required string length: 1 - 15
Pattern: ^[0-9]+$
Example:

"5555555555"

walletAddress
string

The user's EVM wallet address

solanaAddress
string

The user's Solana wallet address

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$
createdAt
string<date-time>

When the user was created

updatedAt
string<date-time>

When the user was last updated

The link to the external verification page for the application

The link to the completion page for the application

applicationReason
string

The reason for the application status