Update a user

patch

https://sandbox.getunblock.com/user

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

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

first_name

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.

last_name

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.

date_of_birth

string

Date format should be YYYY-MM-DD

string

Unique per merchant

phone

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.

sign_in_crypto_address

string

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

target_address

string

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

target_address_type

string

enum

Specifies whether the address is hosted or self-hosted

Allowed:

target_address_vasp

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.

target_solana_address

string

Needs to be an active and rent exempt solana account address

target_solana_address_type

string

enum

Specifies whether the solana address is hosted or self-hosted

Allowed:

target_solana_address_vasp

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.

bvn

string

Bank verification number used for customers in Nigeria

ssn

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).

investment_objective

string

enum

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

Allowed:

annual_income_range

string

enum

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

accepted_terms_and_conditions_hash

string

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

accepted_privacy_policy_hash

string

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

accepted_terms_of_service_hash

string

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

third_party_end_user_agreement_hash

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.

occupation

string

enum

User occupation (optional)

Responses

204

Action has been accepted

400Body malformed

401Unauthorized

404Resource not found

409Already exists

500Unknown error