HomeGuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Create a user

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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.

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.

string

Date format should be YYYY-MM-DD

string
required

Unique per merchant

string

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

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

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

Allowed:
string

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

string
required

Country of residence of the Individual. Requires a valid ISO 3166-1 alpha-2 country code

string

Bank verification number used for customers in Nigeria

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

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)

tokenPreferences
array of objects
tokenPreferences
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
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

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

Responses

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