PUT/api/v2/users/{userId}

Update user information

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
userId (path)unknownYesUser ID

Request body

application/json

Request body fields
FieldTypeRequiredDescription
ExternalUserIdstringNo
FirstNamestringNo
LastNamestringNo
PhonestringNo
MetadataobjectNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
IdunknownNo
ExternalUserIdstringNo
EmailstringNo
FirstNamestringNo
LastNamestringNo
StatusAccountStatusV2No
KycStatusKycStatusV2No
KycLevelKycLevelV2No
CreatedAtstringNo
UpdatedAtstringNo
CompanyIdunknownNo
PackageIdunknownNo
BusinessNamestringNo
BusinessExternalIdstringNo
BusinessParentIdunknownNo
AccountTypebusiness | personalNoAllowed values: business, personal.
PrimaryExternalWalletIdstringNo
SelectedTierIdunknownNo
TierBillingCyclestringNo
OnboardingProductPreferencestringNo

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

404 — Not Found

Response 404 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X PUT "https://{base_url}/api/v2/users/{userId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.