Create a user

post

https://sandbox.getunblock.com/user

Creating a user which is used as the base entity for all other requests

Body Params

first_name

string

required

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

required

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

required

Unique per merchant

sign_in_crypto_address

string

Needs to be a valid ethereum address used for SIWE login purposes only. Initially defaults to target_address if no value is provided

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 by VASP or self hosted by the user

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 by VASP or self hosted by the user

Allowed:

target_solana_address_vasp

string

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

country

string

required

Country of residence of the Individual. Required a valid ISO 3166-1 alfa-2 country code

bvn

string

Bank verification number used for customers in Nigeria

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.

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)

tokenPreferences

array of objects

tokenPreferences

external_user_id

string

Optional external identifier for the user in your system. Used for mapping between your records and Unblock user records.

third_party_end_user_agreement_hashes

array of objects

third_party_end_user_agreement_hashes

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.

ip_address

string

IP Address of the user. May be required for US users that interact with USD

Responses

201Successful created a user

400Body malformed

401Unauthorized

409Already exists

500Unknown error