API ReferenceAuthentication & KeysAuthentication

Get current user

Get the current authenticated user's profile.

Authentication

AuthorizationBearer

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

Headers

X-API-Keystring or nullOptional

Response

Successful Response
cognito_substring
created_atdatetime
emailstring
email_notificationsboolean
full_namestring
idstringformat: "uuid"
kyc_statusenum
KYC verification status enumeration.
Allowed values:
preferred_languagestring
push_notificationsboolean
roleenum
User role enumeration for access control.
Allowed values:
statusenum
User account status enumeration.
Allowed values:
timezonestring
usernamestring
avatar_urlstring or nullOptional
background_image_urlstring or nullOptional
biostring or nullOptional
card_densitystringOptionalDefaults to comfortable
citystring or nullOptional
first_namestring or nullOptional
holdings_visiblebooleanOptionalDefaults to false
last_login_atdatetime or nullOptional
last_namestring or nullOptional
leaderboard_visiblebooleanOptionalDefaults to true
notification_preferencesmap from strings to anyOptional
open_risk_eventsintegerOptionalDefaults to 0
phone_numberstring or nullOptional
postal_codestring or nullOptional
price_displaystringOptionalDefaults to cents
profile_publicbooleanOptionalDefaults to false
provincestring or nullOptional
trading_preferencesmap from strings to anyOptional

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error