Skip to main content
GET
Retrieve an account

Authorizations

Authorization
string
header
required

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

Path Parameters

id_or_reference
string
required

Response

OK

bank_payment_reference
string
required

Reference used to identify bank payments for the account.

base_currency
enum<string>
required

Currency used for account valuation.

Available options:
EUR,
USD,
GBP
can_deposit
boolean
required

Whether deposits are currently allowed.

can_place_buy_order
boolean
required

Whether buy orders are currently allowed.

can_place_sell_order
boolean
required

Whether sell orders are currently allowed.

can_withdraw
boolean
required

Whether withdrawals are currently allowed.

created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

funding_currencies
enum<string>[]
required

Currencies accepted for account funding.

Available options:
EUR,
USD,
GBP
has_deposited
boolean
required

Whether the account has completed a deposit.

has_placed_buy_order
boolean
required

Whether the account has placed a buy order.

has_placed_sell_order
boolean
required

Whether the account has placed a sell order.

has_withdrawn
boolean
required

Whether the account has completed a withdrawal.

id
string
required

Unique resource identifier.

is_primary_owner_mifid_pro
boolean
required

Whether the primary owner is classified as a MiFID professional.

modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.

name
string
required

Display name of the account.

reference
string
required

Customer-visible account reference.

status
enum<string>
required

Current account status.

Available options:
active,
suspended,
closing,
closed