Upvest Investment API.
API Reference/- Retrieve ISA allowances
Create a tax wrapper for ISA account
ISA Tax Wrappers events
ISA Allowance events
Retrieve ISA allowances
Upvest Investment API (1.78.1)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Headers
Bodyapplication/jsonBearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
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
Example: ccb07f42-4104-44ad-8e1f-c660bb7b269c
Types of the ISA tax wrapper
Default "STOCKS_AND_SHARES_ISA"
Value"STOCKS_AND_SHARES_ISA"
- Sandbox environmenthttps://sandbox.upvest.co/isa/wrappers
- Live environmenthttps://api.upvest.co/isa/wrappers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://sandbox.upvest.co/isa/wrappers \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'idempotency-key: ccb07f42-4104-44ad-8e1f-c660bb7b269c' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062' \
-d '{
"account_group_id": "0d68fea2-66e8-4ea8-b507-276e7a1eb4aa",
"type": "STOCKS_AND_SHARES_ISA",
"is_flexible": true
}'ISA tax wrapper created.
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.
Enum"NEW""ACTIVE""INACTIVE""CLOSED"
Response
application/json
{ "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1", "created_at": "2025-10-05T14:48:00.000Z", "updated_at": "2025-10-05T14:48:00.000Z", "account_group_id": "0d68fea2-66e8-4ea8-b507-276e7a1eb4aa", "is_flexible": true, "status": "NEW", "type": "STOCKS_AND_SHARES_ISA" }
Query
Sort the result by created_at or valid_from
Default "created_at"
Enum"created_at""valid_from"
Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.
Default "ASC"
Enum"ASC""DESC"
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environmenthttps://sandbox.upvest.co/isa/wrappers/{tax_wrapper_id}/allowances
- Live environmenthttps://api.upvest.co/isa/wrappers/{tax_wrapper_id}/allowances
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/isa/wrappers/{tax_wrapper_id}/allowances?tax_year=string&sort=created_at&order=ASC&offset=0&limit=100' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'OK
Type of the allowance:
- ANNUAL - Allowance valid for a tax year.
Default "ANNUAL"
Value"ANNUAL"
Status of the allowance:
- ACTIVE - Current allowance.
- EXPIRED - Allowance from previous years.
Enum"ACTIVE""EXPIRED"
Alphabetic three-letter ISO 4217 currency code.
- GBP - British Pound Sterling
Default "GBP"
Value"GBP"
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 1, "total_count": 1, "sort": "valid_from", "order": "DESC" }, "data": [ { … } ] }
Bodyapplication/json
The type of ISA tax wrapper event
- 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.
Enum"ISA_WRAPPER.NEW""ISA_WRAPPER.ACTIVE""ISA_WRAPPER.INACTIVE""ISA_WRAPPER.CLOSED"
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.
Enum"NEW""ACTIVE""INACTIVE""CLOSED"
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
- Sandbox environmenthttps://sandbox.upvest.co/ISA tax wrapper events
- Live environmenthttps://api.upvest.co/ISA tax wrapper events
application/json
{ "id": "295cf14f-368c-450e-b57e-48d115d30fe4", "created_at": "2025-08-01T10:34:43Z", "type": "ISA_WRAPPER.NEW", "object": { "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1", "created_at": "2025-08-01T10:33:43Z", "updated_at": "2025-08-01T10:33:43Z", "account_group_id": "d4b5c6e7-89f0-4a1b-9c2d-3e4f5a6b7c8d", "is_flexible": true, "status": "NEW", "type": "STOCKS_AND_SHARES_ISA" }, "webhook_id": "4a80c45f-204c-4498-ac20-d900a846e166" }