Get user details

The endpoint returns the user’s details based on their user ID. The response includes information about the user’s status (such as active or verified), the result of the appropriateness questionnaire, pending acceptance of terms & conditions, and more.

SecuritybearerAuth

Request

path Parameters

User-ID

required

string <uuid>

User ID

query Parameters

user_journey

string

Filters terms_not_accepted for a specific user journey. If not provided, all not accepted terms are included in the response.

Enum: "onboarding" "trading_stocks_buy" "trading_stocks_sell" "trading_etf_buy" "trading_etf_sell" "trading_metals_buy" "trading_metals_sell"

header Parameters

Accept-Language

string

ISO 639-1 2-letter code representing user's language

Example: en

Responses

200

Get user details

401

Invalid user

422

Error

429

Too Many Requests

503

Maintenance or Service unavailable

get/v1/users/{User-ID}

Request samples

curl
JavaScript
Node.js
Python
PHP

Response samples

application/json

{"data": {"id": "2e4c89ac-1290-426f-8de0-4c7b40b91d3a",
"appropriateness_tag": {"short_name": "appropriateness.not_appropriate",
"requires_test_completion": false,
"requires_test_resubmission": false
},
"active": true,
"blacklisted": false,
"verified": true,
"trading_active": {"status": true,
"reason": "Trading disabled"
},
"account_level_id": "1",
"verification_details": {"status": "completed",
"reason": "User is verified"
},
"terms_not_accepted": [1,
2
]
}
}