Skip to content
Documentation/
/
/
Create Account Groups

Creating an account group

After you have created the user, you can set up the parent account group as follows:

POST /account_groups

This request accepts two parameters in its body:

ParameterDescription
user_idRequired: The ID of the user to be associated with this account group.
typeRequired: Possible values are

- PERSONAL: Account group of a person who holds assets in their own name.

- LEGAL_ENTITY: Account group of a legal entity that holds assets in the name of its users.

- FRENCH_PEA: Account group of a person who holds assets in their own name in the Plan d'Épargne en Actions, a tax-efficient investment wrapper for residents of France. We support one FRENCH_PEA account group per user.

- ISA: Account group for UK residents holding assets in an Individual Savings Account (ISA).Visit the ISA Integration Guide for more information.

- Child: Account group for a child user holding assets in a child account. Visit the Child Accounts Guide for more information.

Example

{
  "user_id": "413715f2-5401-4b97-8055-034a6b879f8c",
  "type": "PERSONAL"
}

In the response to this request, you will receive an account group ID, which is needed to create an account and to take further actions on the account group itself.

Account group status

The response to the request to create an account group, contains status field.

The following statuses can apply to an account group:

StatusDescription
PENDING_APPROVALAccount group approval is pending - the account group is visible via our API but cannot be acted on.
ACTIVEAccount group is active - full functionality of the Investment API is accessible.
LOCKEDAccount group is locked for all actions.
CLOSINGAccount group is closing.
CLOSEDAccount group is closed.

Initially this will be the PENDING APPROVAL status.

As soon as all requirements for activating the account group are met, its status will transition to ACTIVE.

Our flexible regulatory checks ensure that the onboarding process only takes a few seconds instead of days.

Webhooks

You will also receive the following webooks notifying you of the key events in account group creation and acitivation:

Listing account groups

You can list all account groups of a specific user with

All account groups can be listed with

Next steps

After successfully creating the account group, you can now dedicate yourself to creating an account.