POST
/
v1
/
user
/
create
curl --request POST \
  --url https://staging.terminal3.io/v1/user/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <x-api-token>' \
  --data '{
  "wallet": {
    "address": "<string>",
    "chain_id": "<string>"
  },
  "profile": {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "user_name": "<string>",
    "email_address": "jsmith@example.com",
    "mobile_number": 1,
    "mobile_country_code": "<string>",
    "avatar": "<string>",
    "language_others": [
      "<string>"
    ],
    "residence_country": "<string>",
    "residence_province": "<string>",
    "residence_city": "<string>",
    "gender": "male",
    "date_of_birth": "<string>",
    "language_primary": "<string>",
    "employment_status": "employed",
    "employment_industry": 123,
    "marital_status": "single",
    "education": "doctorate",
    "household_income": "10000-"
  }
}'
{
  "data": {
    "user_id": 123
  }
}

This API allows you to create a Terminal 3 user account based on an email or (optional) wallet address. User data will be securely stored in decentralized storage.

The UserProfile schema must adhere to the following format. Please ask us for more details on the validation rules for each field.

JSON
{
email_address: string;
first_name: string;
middle_name?: string;
last_name: string;
user_name?: string;
residence_country?: CountryOptions;
residence_province?: ProvinceOptions;
residence_city?: CityOptions;
mobile_number?: number;
mobile_country_code?: string;
gender?: GenderOptions;
date_of_birth?: string;
language_primary?: LanguageOptions;
language_others?: LanguageOptions;
employment_status?: EmploymentStatusOptions;
employment_industry?: EmploymentIndustryOptions;
marital_status?: MaritalStatusOptions;
education?: EducationOptions;
household_income?: HouseholdIncomeOptions;
}

Example input payload:

JSON
{
"wallet": {
  "address": "0x2EF2922885EDcf2151f6C863e58adcEc70c11356",
  "chain_id": "1"
},
"profile": { ...UserProfile }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-token
string
required
​
x-api-subclient-id
string

Body

application/json
​
profile
object
required
​
wallet
object

Response

200
application/json
Success
​
data
object
required