Accounts

Create an account

Creates an account for a user or a business within an existing account group.

The account is created with status PENDING_APPROVAL and switches to ACTIVE once the owner's onboarding is complete; subscribe to the ACCOUNT.ACTIVATED webhook event to be notified. An account cannot exist without an account group and holds positions in the form of units.

For a JOINT account group, user_id must be one of its 2 owners; either owner can be used. The account is shared by both owners and its users list both of them with type OWNER. A second owner whose OWNER role is still PENDING is not yet a member of the account group, and the request returns 404.

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

post/accounts

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/accounts
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: accounts: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 created.

OR

Changes

No recorded changes to this operation across all 25 revisions of this API.