Skip to main content
The Accounts API provides trading account information for partners. Accounts are the containers for positions, balances, and order history.
Accounts are created by KYC, not by a separate call. A trading account is provisioned automatically when a Retail Participant’s KYC verification is approved — there is no manual account-creation endpoint. See Onboard Participants for how KYC creates the Participant and Account together.

Endpoints

MethodEndpointDescriptionAPI reference
GET/v1/accountsList trading accountsList accounts ↗
For participant identity, see Participants. The underlying identity endpoints are documented in the API reference: Get who am I ↗ (GET /v1/whoami) and List users ↗ (GET /v1/users).

Account Hierarchy

Partner (Firm)
└── Retail Participants (created via KYC)
    └── Accounts (auto-provisioned)
        └── Positions & Orders
  • Firm: Your partner organization
  • Retail Participants: Individual retail traders (created when KYC is approved)
  • Accounts: Trading accounts (automatically provisioned with the participant)

List Accounts

Returns the trading accounts available to the authenticated user.

Request

GET /v1/accounts
Optional query parameter:
  • user - Filter by user ID

Response

{
  "accounts": [
    "firms/ISV-Participant-Acme/accounts/user-123-trading",
    "firms/ISV-Participant-Acme/accounts/user-456-trading"
  ],
  "displayNames": [
    "John's Trading Account",
    "Jane's Trading Account"
  ]
}

Response Fields

FieldTypeDescription
accountsarrayAccount identifiers
displayNamesarrayHuman-readable account names (parallel array)

Participant vs Account

EntityDescription
ParticipantA person with a verified identity (KYC). Created automatically on KYC approval.
AccountA trading account with balances and positions. Auto-provisioned with the participant.
A Retail Participant can have multiple accounts for different purposes (e.g., separate trading strategies).