Account Information
Account Personal Information
This guide covers retrieving and managing account and user profile information.
Overview
Account information is organized in the User → Client Account → Sub-Account hierarchy:
- User: Your login identity and preferences
- Client Account: Legal entity information (KYC data)
- Sub-Accounts: Trading portfolios
Prerequisites
- Authenticated session (JWT or API key)
CanReadpermission
Part 1: Current User Information
Get Current User Profile
Retrieve information about the authenticated user.
Endpoint: GET /api/rest/v1/users/me
Request
Response (200 OK)
User Status Values
User Types
Part 2: User Preferences
Get User Preferences
Endpoint: GET /api/rest/v1/users/me/preferences
Response (200 OK)
Preference Fields
Update User Preferences
Endpoint: PUT /api/rest/v1/users/me/preferences
Part 3: Client Account Information
Get My Client Account
Retrieve the legal entity information for your Client Account.
Endpoint: GET /api/rest/v1/client-accounts/mine
Request
Response (200 OK)
Client Account Status
Verification Status
Client Account Types
Part 4: Sub-Account Information
List My Sub-Accounts
Endpoint: GET /api/rest/v1/sub-accounts/mine
Request
Query Parameters
This endpoint supports standard pagination, sorting, and filtering.
Response (200 OK)
Get Single Sub-Account
Endpoint: GET /api/rest/v1/sub-accounts/{id}
Response (200 OK)
Sub-Account Types
Sub-Account Venues
Pair Restrictions
- Empty
pairsarray: Access to all trading pairs - Non-empty
pairsarray: Access limited to listed pair IDs
Part 5: List Users (Account Manager)
If you have CanManage permission, list all users in your Client Account.
Endpoint: GET /api/rest/v1/users
Request
Query Parameters
This endpoint supports standard pagination, sorting, and filtering.
Response (200 OK)
List Users in Sub-Account
Endpoint: GET /api/rest/v1/users/by-sub-account/{subAccountId}
Part 6: User Attributes
User attributes store additional metadata about the user.
List My Attributes
Endpoint: GET /api/rest/v1/users/me/attributes
Get Specific Attribute
Endpoint: GET /api/rest/v1/users/me/attributes/{attributeId}
Update Attributes
Endpoint: POST /api/rest/v1/users/me/attributes
Delete Attribute
Endpoint: DELETE /api/rest/v1/users/me/attributes/{attributeId}
Part 7: Client Account Attributes
List My Client Account Attributes
Endpoint: GET /api/rest/v1/client-accounts/mine/attributes
Get Specific Client Account Attribute
Endpoint: GET /api/rest/v1/client-accounts/mine/attributes/{attributeId}
Summary: Information Hierarchy
Error Scenarios
Related
- Authentication - Authentication flow
- Wallet Information - Balance information
- Domains: Accounts - Full account API reference
- Domains: Core Concepts - Core concepts