UPupvest
Account Groups

Create an account group

Changed on

Creates an account group for a user or a business.

An account group aggregates the accounts within it for tax calculation and regulatory reporting purposes and holds positions in the form of cash; the official securities account number is assigned at account group level. The account group is created with status PENDING_APPROVAL and switches to ACTIVE once onboarding is complete.

See the Creating account groups guide (TOL / BYOL) for implementation details.

post/account_groups

Request

  • Base URL
    https://sandbox.upvest.co
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://sandbox.upvest.co/auth/token
    Scopesaccounts:admin

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency

Request body

OR

Response

Account group created.

OR

Changes

  • c8a00277f131Revision changes
    • warning

      added the new PENSION_DE_CHILD enum value to the / response property for the response status

    • info

      added the new PENSION_DE_CHILD enum value to the request property /

  • 85aff1852bf8Revision changes
    • warning

      added the new JOINT enum value to the / response property for the response status

    • info

      added the new JOINT enum value to the request property /