Creating accounts
Prerequisites
You must have
After the creation of the account group, you can now setup an account with:
POST /accounts
Example
{
"user_id": "413715f2-5401-4b97-8055-034a6b879f8c",
"account_group_id": "fa2414ed-8d62-46fd-85ed-565a340c81d6",
"type": "TRADING",
"name": "Main account"
}
Parameter | Description |
---|---|
user_id | The ID of the user to be associated with this account. |
account_group_id | The ID of the account group to be associated with this account. |
type | Specify the type TRADING or PORTFOLIO for this account. |
name | Optionally, you can provide a nickname for the account that can be used for reporting purposes. |
The account will be created with the PENDING_APPROVAL
status and switches to ACTIVE
as soon as the user onboarding process is completed.
Furthermore, you will receive a webhook with the respective account created event. As soon as all prerequisites for activating the account are passed, you also receive an account activated event.
Webhooks notify you of events in business processes, not the success or failure of the initialisation of those processes.
Please be sure to check the HTTP status of the response to your requests and handle failure cases appropriately.
Account status
The following status apply to an account:
Status | Description |
---|---|
PENDING_APPROVAL | Account approval is pending - the account is visible via our API but cannot be acted on. |
ACTIVE | Account is active - full functionality of the Investment API is accessible. |
LOCKED | Account is locked for all actions. |
CLOSING | Account is closing - only sell orders or the transfer of positions out are permissible before the account is closed. |
CLOSED | Account is closed with zero balance successfully. |
Listing accounts
You can list all accounts of a specific user with
All accounts can be listed with
GET
/accounts
Next steps
You are all set now: a user is onboarded and an account group as well as an account have been created. Your user is now ready to fund the account and to place the first order. Follow the Payments guide.