JOjoinsophic
accounts

Retrieve an account

Changed on

Retrieve an account by ID or reference.

get/accounts/{id_or_reference}

Request

  • Base URL
    https://api.engine.usesophic.com
  • Auth
    HTTP bearer

Path parameters

id_or_referencestring required

Response

OK

bank_payment_referencestring required

Reference used to identify bank payments for the account.

base_currency'EUR' | 'USD' | 'GBP' required
can_depositboolean required

Whether deposits are currently allowed.

can_place_buy_orderboolean required

Whether buy orders are currently allowed.

can_place_sell_orderboolean required

Whether sell orders are currently allowed.

can_withdrawboolean required

Whether withdrawals are currently allowed.

created_atstring date-time required

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

funding_currenciesCurrency[] required

Currencies accepted for account funding.

has_depositedboolean required

Whether the account has completed a deposit.

has_placed_buy_orderboolean required

Whether the account has placed a buy order.

has_placed_sell_orderboolean required

Whether the account has placed a sell order.

has_withdrawnboolean required

Whether the account has completed a withdrawal.

idstring required

Unique resource identifier.

is_primary_owner_mifid_proboolean required

Whether the primary owner is classified as a MiFID professional.

modified_atstring date-time required

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

namestring required

Display name of the account.

referencestring required

Customer-visible account reference.

status'active' | 'suspended' | 'closing' | 'closed' required

Changes

  • 6a63920239d8Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new EUR enum value to the response property for the response status

    • warning

      added the new GBP enum value to the response property for the response status

    • warning

      added the new USD enum value to the response property for the response status

    • warning

      added the new active enum value to the response property for the response status

    • warning

      added the new closed enum value to the response property for the response status

    • warning

      added the new closing enum value to the response property for the response status

    • warning

      added the new suspended enum value to the response property for the response status

    • info

      removed from the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status

  • aa43bab6253cRevision changes
    • breaking

      response property context/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 400