The release notes on this page describe the API at the time of release. Refer to Latest releases for the latest release notes.
Also note, that the API Reference reflects the most current behaviour.
Version 1.81.0 release
Version 1.81.0 adds a new enum, TRANSACTION_FEE, to the type parameter in the Treasury reports events webhook. This supports the new Transaction fee execution report.
Version 1.80.0 release
Release of dynamic prices in Sandbox environment This release adds enhanced dynamic pricing for the following three (3) ISINs in the Sandbox environment:
LU0429790743 IE00B3VTMJ91 IE00BF20LF40 This feature algorithmically mimics normal market behavior to allow prices to increase and decrease over time. It also allows execution prices to more closely align the ISIN’s latest price as shown in the sandbox environment.
View more information in the Dynamic Pricing section of the guide.
Version 1.79.0 release
Release of the account transfer functionality
This release introduces our account transfer functionality. With the /account_transfer endpoint, clients can facilitate the transfer of multiple ISINs from a single account across custodians. This functionality supports both incoming and outgoing account transfers.
This new functionality gives end users the ability to initiate a transfer request directly in the clients’ User Interface (UI) / app and allows our clients to pass the request to Upvest via API.
Version 1.78.1 release
Version 1.78.1 deprecates the rebalancing_strategy_ids parameter from the POST /portfolios/configurations endpoint.
Version 1.78.0 release
This release introduces our securities transfer functionality. With the /securities_transfer endpoint, clients can facilitate the transfer of securities across custodians, in both directions.
With this endpoint, Upvest now provides:
- Incoming security transfers: when moving securities into your account.
- Outgoing security transfers: when moving securities to an external custodian.
This new functionality gives end users the ability to initiate a transfer request directly in the clients’ User Interface (UI) / app and allows our clients to pass the request to Upvest via API.
View the Securities Transfers Guide for more information.
Version 1.77.1 release
Version 1.77.1 adds sorting and pagination parameters to /isa/wrappers/{{tax_wrapper_id}}/allowances endpoint.
Version 1.77.0 release
Version 1.77.0 adds support for Great British Pounds (GBP) in the currency field of our Fees endpoint. This is in preparation to support additional currencies in a future release. Currently, only Euro (EUR) is supported for fee collection.
Version 1.76.0 release
The version 1.76.0 release includes new functionality to receive payments and manage funds by leveraging virtual International Bank Account Numbers (vIBANs). This functionality supports credit funding by allowing users to easily receive money and top up their balances to their vIBAN.
For more information, visit the Virtual IBAN Guide.
Release of our updated documentation portal
We are pleased to announce the newest version of our API documentation! This update improves the overall user experience with a number of key features that makes it easier for you to find the information you’re looking for.
Key Features include:
Cleaner interface and navigation: includes a new Products dropdown allowing you to easily navigate to the correct guide for your operating model.
Enhanced search results: provides relevant search results to match the operating model you’re currently viewing.
Enriched AI search functionality: allows you to ask questions in a conversational manner and receive a summary of information from across our entire library.
Code examples in multiple languages: adds automatically-generated code examples in eight (8) common programming languages directly within the API reference.
We hope this enhancement improves the way you access information about our API.
Version 1.75.0 release
Version 1.75.0 introduces our tax wrapper functionality. With the /isa and /pea endpoints, clients can integrate Individual Savings Accounts (ISA) for tax residents of the United Kingdom and Plan d'Épargne en Actions (PEA) for tax residents of France.
We are introducing two new webhooks to help manage the tax wrapper process: ISA_WRAPPER and ISA_WRAPPER_ALLOWANCE.
These provide status updates:
- When a new tax wrapper is created.
- Updates for new inflows and outflows to the tax wrapper.
- When a tax wrapper expires.
We've added the following new account group types: ISA: Account group for French residents holding assets in a Plan d'Epargne en Actions (PEA) PEA: Account group for UK residents holding assets in an Individual Savings Account (ISA).
View the details in our Tax Wrapper Guide. This section includes two new guides:
- ISA Integration Guide: For information on implementing Individual Savings Accounts (ISA) for residents of the United Kingdom.
- PEA Integration Guide: For information on implementing Individual Savings Accounts (PEA) for residents of France.
Version 1.74.0 release
Version 1.74.0 includes instructions for the new Tax Collection process for tax payments. This includes a specific section for the collection of preliminary lump-sum taxes (Vorabpauschale) required under German Tax Law.
Version 1.73.0 release
Version 1.73.0 introduced new charge method for fee configuration - COLLECTED_BY_UPVEST
Version 1.72.3 release
Version 1.72.3 updates the reference list of supported tax identification numbers (TINs).
Version 1.72.2 release
Version 1.72.2 introduces a new ISIN IE00BK5BQX27 to limit & stop order simulation flows.
Version 1.72.1 release
Version 1.72.1 updates the reference list of supported tax identification numbers (TINs).
Version 1.72 release
Version 1.72.0 introduces the Reminder webhook for savings plan executions: SAVINGS_PLAN_EXECUTION.REMINDER. This webhook allows you to receive notifications ahead of each scheduled execution.
Version 1.71.0 release
With this release, we have added new cash and security transaction types.
Version 1.70.0 release
With this release, we have added support for clients to specify inducements (e.g. payments from fund issuers to our clients) in ex-ante cost disclosures. Inducements are now split into two categories in the response and PDF report:
- third-party inducements – Upvest
- third-party inducements – Partner
Version 1.69.0 release
With this release, we have enhanced the visibility of transaction fees in order execution cash transactions:
- the
feesfield is now included in cash transactions for order executions with applicable transaction fees - the
TRANSACTION_FEE_EXECUTIONreference type is now included inreferencesfor cash transactions involving fees collected by Upvest
Version 1.68.0 release
Version 1.68.0 updates the list of statuses that savings plan execution can have.
Savings plans
Removed READY_FOR_EXECUTION and SUBMITTED values from the list of possible statuses that savings plan execution can take.
Version 1.67.2 release
Version 1.67.2 updates the description of purpose_code by adding list of valid purpose codes.
Direct Debits
Updated purpose_code field validation for direct debit operations.
Withdrawals
Updated purpose_code field validation for withdrawal operations.
Version 1.67.1 release
Version 1.67.0 release
Version 1.67.0 introduces new purpose_code fields for the following operations:
Direct Debits
New purpose_code fields for direct debit operations.
Withdrawals
New purpose_code fields for withdrawal operations.
Version 1.66 release
Webhook Documentation Update - Stale Subscription Removal Policy
With this release, we have added a policy to our webhook documentation regarding the removal of stale subscriptions in the sandbox environment.
Version 1.65 release
With this release, we have deprecated the field credit_debit_factor in the corporate action notifications webhook. It has been replaced with the field credit_debit_indicator to align more closely with the ISO 15022 standard.
Version 1.64 release
With this release, with have added a TOPUP webhook event type to the list of supported webhook events.
Version 1.63 release
With this release, with have added a support for GBP currency in the orders endpoints. Please contact us before you begin trading with GBP currency.
Version 1.62.3 release
With this release, the schema of valuations endpoints/webhooks was adjusted to indicate the correct pattern for the following:
- for
total_security_value.amountandsecurity_positions[*].value.amountfields, changed to non-negative numerical value with up to 2 digits after decimal point, - for
weightandsecurity_positions[*].quantity, changed to numerical value with up to 10 digits after decimal point.
Version 1.62.0 release
With this version, successful responses to requests to increase or decrease virtual cash balances for an account group are returned with HTTP status code 202 (instead of the previous 200).
The aim of this change is to better reflect the semantics of the endpoint (success meaning the request was issued, not necessarily processed right away).
Version 1.61.0 release
Version 1.60.0 release
With this version, we are introducing a new read-only optional taxes field on withdrawals.
This new field will not influence any existing setups.
Version 1.59.0 release
With this version, we are introducing two new enum values TWO_PLUS_TWO_VERIFICATION_PROOF and TWO_PLUS_TWO_VERIFICATION, for the Know-Your-Customer (KYC) document type and for the KYC method respectively, when performing a user check.
This KYC document type and method is permitted for all users resident in GB.
| Field | Value | Description |
|---|---|---|
document_type | TWO_PLUS_TWO_VERIFICATION_PROOF | Two plus two verification proof (for GB residence users only) |
method | TWO_PLUS_TWO_VERIFICATION | A method of verifying identity by matching at least two personal details from two separate sources (for GB residence users only) |
Version 1.58.0 release
This release introduces a new endpoint to allow clients to list all cash balances (across all supported currencies): /account_groups/{account_group_id}/payments/cash_balances
NOTE Please note that the previous endpoint /payments/cash_balance, via which only cash balances in EURO could be retrieved, remains functional but will be marked as deprecated for future removal.
Version 1.57.0 release
This release introduces a new endpoint to allow clients to retrieve the cash balance for each supported currency by specifying it in the following URL: /account_groups/{account_group_id}/payments/cash_balances/{currency}
| Parameter | Description | Example |
|---|---|---|
currency | Enter the ISO code for the currency in which you would like to receive the cash balance. | EUR |
NOTE Please note that the previous endpoint /payments/cash_balance, via which only cash balances in EURO could be retrieved, remains functional but will be marked as deprecated for future removal.
Support of new corporate action types in the notifications
Please note that we now support sending notifications for the following types of corporate actions:
- conversion
- stock dividend
- bonus issue/capitalisation issue.
The notifications for the newly supported types have the same format as the notifications for all other types, so there are no changes to the API specifications, but you can expect notifications from now on when we receive corporate actions with these types.
Version 1.56.1 release
With this version, branches can also be created for clients who use the Bring your own license/ single accounts (BYOL SA) operating model; the user schema has also been extended accordingly.
Version 1.56.0 release
This version adds the following corporate action transaction types to the docs:
CAPITAL_GAINS_DISTRIBUTIONCAPITAL_GAINS_DISTRIBUTION_CANCELLATION
Version 1.55.0 release
The following types of corporate actions are now also supported in the CA notifications with this release:
- merger
- liquidation dividend/ liquidation payment.
Version 1.54.0 release
Additional corporate action type
We now also support the delisting of corporate actions for our notifications.
New optional field
The object representing the corporate action and the associated processing status now has a new optional field.
| Parameter | Description |
|---|---|
additional_text | Optional: Provides additional details or specifies in more detail the content of a corporate action notification. |
Example
"properties": [
"additional_text": {
"title": "Additional text",
"description": "Provides additional information.",
"type": "string"
}
]Version 1.53.0 release
With version 1.53.0 we have added account_group_id as references type to the following report types:
income_distributiontax_refund.
Version 1.52.0 release
Corporate actions guides
We have put a lot of work into developing our corporate action feature, including notifications. We want to honour this with equally thorough documentation.
Please find our updated guides on corporate actions with all the background knowledge and integration guidelines here:
Version 1.51.1 release
We are gradually expanding our support for notifications of further corporate action types. This release includes the following types:
- tender/acquisition/takeover/purchase offer
- spin-off
- dividend reinvestment
- change
Version 1.50.0 release
With this version, we are introducing the new enum value QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX for the Know-Your-Customer (KYC) method when performing a user check.
This KYC method is permitted for all users based in Europe.
| Parameter | Description |
|---|---|
QUALIFIED_ELECTRONIC_SIGNATURE_WITH_TX | Required: Qualified electronic signature in connection with a bank transaction for verification. |
Version 1.49.0 release
This version of the Investment API launches the new field currency in our treasury report body:
| Parameter | Description | Example |
|---|---|---|
currency | Required: The currency of the treasury payment. Alphabetic three-letter ISO 4217 currency code. | EUR |
Version 1.48.0 release
This release introduces the missing transaction type LIQUIDATION_PAYMENT and LIQUIDATION_PAYMENT_CANCELLATION for the corporate actions related transactions.
Version 1.46.0 release
In preparation for the multi currency capability in our Investment API, we have added the field currency to the direct debit payments and withdrawals.
Please note that currently only EUR is supported (if no specification is made here, it will fall back to the default value EUR).
Further currency types will follow.
Version 1.45.0 release
This release brings two additional corporate action types that the Investment API now supports for notifications. These are:
- stock split/ change in nominal value/ subdivision
- reverse stock split change in nominal value.
We have also introduced the new field for the currency_denomination; the currency in which a financial instrument is currently denominated according to ISO Standard.
Best practice guide for integrating webhooks
This guide is designed to help clients achieve a smooth and reliable webhook integration with Upvest.
Find out how you can set up efficient event processing.