Account Groups

Close an account group by ID

Initiates the closure of the account group specified by its ID.

Closure is a two-step process: the account group status changes to CLOSING, and once all preconditions are met it transitions to CLOSED. Subscribe to the ACCOUNT_GROUP.CLOSING_INITIATED and ACCOUNT_GROUP.CLOSED webhook events to track progress.

See the Closing accounts guide (TOL / BYOL) for preconditions and implementation details.

delete/account_groups/{account_group_id}

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/account_groups/{account_group_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: accounts:admin)

Query parameters

closure_reason'dunning' | 'power_of_attorney' | 'loss_of_legal_capacity' | 'aml' | 'risk_based' | 'contract_breach' | 'user_initiated'

Records the reason for the account group closure.

notification_onlyboolean

Indicates whether the request notifies of an intended future closing.

Response

The request has been successfully accepted and will be processed asynchronously.

Changes

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