ISA

Create a tax wrapper for ISA account

Changed on

Creates an ISA tax wrapper for an account group, holding the business rules that apply to the tax-wrapped product.

The account group must have been created with type set to ISA. For a STOCKS_AND_SHARES_ISA, set is_flexible to indicate whether the end user may replace withdrawals within the same tax year without using up their annual allowance. A tax wrapper stays inactive until the end user's tax residency has been confirmed, and the ISA account group cannot become ACTIVE until the tax wrapper does.

See the ISA tax wrapper integration guide (TOL / BYOL) for the onboarding and activation sequence.

post/isa/wrappers

Request

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

account_group_idstring uuid required

The ID of the account group to which the tax wrapper belongs.

type'STOCKS_AND_SHARES_ISA' required

The kind of ISA that the tax wrapper represents.

  • STOCKS_AND_SHARES_ISA — A Stocks and Shares ISA.
is_flexibleboolean required

True if ISA is flexible.

Response

ISA tax wrapper created.

idstring uuid required

Tax wrapper unique identifier.

created_atstring date-time required

The date and time the tax wrapper was created.

updated_atstring date-time required

The date and time the tax wrapper was last updated.

account_group_idstring uuid required

Account group unique identifier.

is_flexibleboolean required

True if tax wrapper is flexible.

status'NEW' | 'ACTIVE' | 'INACTIVE' | 'CLOSED' required

Status of the tax wrapper

  • NEW - The tax wrapper is newly created and not yet active due to pending checks.
  • ACTIVE - The tax wrapper is currently active and in use.
  • INACTIVE - The tax wrapper is not currently active. New subscriptions not allowed.
  • CLOSED - The tax wrapper has been closed and is no longer available.
type'STOCKS_AND_SHARES_ISA' required

The kind of ISA that the tax wrapper represents.

  • STOCKS_AND_SHARES_ISA — A Stocks and Shares ISA.

Changes

  • ca69534b631dRevision changes
    • info

      api operation id create_isa_tax_wrapper removed and replaced with create_isa_wrapper

    • info

      api tag ISA added

    • info

      api tag Tax Wrappers removed