HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Update a user

Updating user details. Most of these fields are ONLY updatable for users which do not have the status FULL_USER

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Optional title for the user (e.g. Mr, Mrs, Ms, Dr).

string

Only letters (no accents). No numbers or special characters.
Length between 2 and 48 characters. The combined length of first_name and last_name must not exceed 50 characters.

string

Only letters (no accents). No numbers or special characters.
Length between 2 and 48 characters. The combined length of first_name and last_name must not exceed 50 characters.

string

Date format should be YYYY-MM-DD

string

Unique per merchant

string

Phone number in the E.164 standard. Field is mandatory for US users, and must be a valid US phone number. Optional for non-US users.

string

Needs to be a valid ethereum address used for SIWE login purposes only

string

Needs to be a valid ethereum address. Normally unique per merchant, unless address is allowed to have duplicates

string
enum

Specifies whether the address is hosted or self-hosted

Allowed:
string

Optional parameter to specify the VASP for target address if the address is hosted. Use GET /vasps to retrieve the list of supported VASPs.

string

Needs to be an active and rent exempt solana account address

string
enum

Specifies whether the solana address is hosted or self-hosted

Allowed:
string

Optional parameter to specify the VASP for solana target address if the address is hosted

address
object

No address fields are mandatory (address_line_1 and post_code are not required). Send only the fields you want to change.

string

Bank verification number used for customers in Nigeria

string

Social Security Number (9 digits, numeric only). Can only be updated before KYC verification starts (statuses: CREATED, PHONE_VERIFICATION_NEEDED, KYC_NEEDED). Must be exactly 9 digits with no dashes or spaces. Forbidden values are rejected (e.g. all zeros, area number 666, or invalid group/serial numbers per SSA rules).

string
enum

Specifies a user’s primary financial goal or strategy for investing.

Allowed:
string
enum

Specifies a user’s approximate yearly income bracket, expressed in USD.

string

A base64 hash of the user-accepted DTR's Terms & Conditions (https://getunblock.com/epmap-terms-of-service)

string

A base64 hash of the user-accepted DTR Privacy Policy (https://www.getunblock.com/ub-privacy-and-policy)

string

A base64 hash of the user-accepted DTR Terms of Service (https://getunblock.com/terms-of-service)

string

Optional. A base64 hash of a single third party end user agreement accepted by the user (for update; use third_party_end_user_agreement_hashes array on create).

mailing_address
object

Optional mailing address. If provided for US, state is required.

string
enum

User occupation (optional)

Responses
204

Action has been accepted

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json