Get a sub-account owned by the authenticating user.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

X-Auth-Token header string Authentication token.
id path string Account UUID, returned by the create account endpoint.
on_behalf_of query string A contact UUID for the sub-acccount you're acting on behalf of.
curl -X GET  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/accounts/{id}


    "id": "cf28b2d8-5afa-4d7f-9a26-7b45bf616a11",
    "account_name": "My Example Account",
    "brand": "currencycloud",
    "your_reference": null,
    "status": "enabled",
    "street": "My Example Street",
    "city": "My Example City",
    "state_or_province": null,
    "country": "GB",
    "postal_code": "Example Code",
    "spread_table": "fxcg_rfx_default",
    "legal_entity_type": "company",
    "created_at": "2018-04-26T15:05:01.000Z",
    "updated_at": "2020-09-07T11:56:59.000Z",
    "identification_type": null,
    "identification_value": null,
    "short_reference": "180426-00018",
    "api_trading": true,
    "online_trading": true,
    "phone_trading": true,
    "process_third_party_funds": false,
    "settlement_type": "net",
    "agent_or_reliance": false,
    "terms_and_conditions_accepted": null,
    "bank_account_verified": "not required"
Error Codes
HTTP Status Code Description Params
400 id_is_not_valid_uuid id should be in UUID format
account_not_found Account was not found for this id
on_behalf_of_self You cannot act on behalf of your own Contact
contact_not_found Contact was not found for this id
401 invalid_supplied_credentials Authentication failed with the supplied credentials
429 too_many_requests Too many requests have been made to the api. Please refer to the Developer Center for more information
500 internal_server_error Internal server error
503 service_unavailable Service is temporary unavailable
Was this post helpful?
Let us know if you liked the post. That’s the only way we can improve.