Open a brokerage account for one of your end users

Note

Opens and activates a brokerage account for one of your end users — the first call you make for any new client, before you can fund them or trade on their behalf.

You identify the client with your own brokerClientId: an id from your own system that you assign and control. Reuse the exact same brokerClientId on every later funding, trading and reporting call for that user, so keep it unique per user and stable over time. You never touch BrokerX's internal account numbers

The call is idempotent — if an account already exists for that brokerClientId, it simply returns the current status instead of creating a duplicate, so it is always safe to retry. Accounts are cash accounts today; the response returns the account status (1 = active).

Body Params
string
required

Your own unique identifier for the end user (assigned and owned by you, external to BrokerX). Reused across all subsequent calls for this user.

string

Account type to open. Optional; defaults to cash. Currently only cash is supported.

Headers
string

Optional client-supplied trace id, echoed through our logs for easier support. Generated for you if omitted.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json