Get account status

Note

Looks up the current state of a client's account by brokerClientId. Use it to confirm an account is active before you fund or trade, or to surface account details in your own dashboard.

It returns whether the account is active or frozen (status), the account type (accType, C = cash), which markets it may trade (accountBusinessType — e.g. 100 = HK equities, 101 = US equities), and when it was activated (bindingAt, Unix ms). Today one brokerClientId maps to a single account.

Errors

These business errors are returned with HTTP 200. Check the JSON code:

ConditionCodeMessage example
brokerClientId is omitted1001Invalid Constraints Required [{brokerClientId}]
brokerClientId is empty or not bound to an account601006CLIENT_NOT_BOUND

An error response can omit data. Message wording may vary; use code for error handling.

Query Params
string
required

Your own unique identifier for the end user.

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