Release Notes

Corporate actions notification: New types

The Investment API now supports corporate action notifications of the following types:

• Intermediate securities distribution
• Dividend option

Read the docs

Go to the API reference

Reference account group in account opening reports

With this release, it is possible to assign account opening reports to a specific account group for clients with multiple account groups.

By specifying the account group ID in the references of an account group, a clear assignment is made possible.

Example

"references": [
          {
            "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
            "type": "ACCOUNT_GROUP_ID"
          }
]

Read the more about multiple account groups

Go to the API reference

The fee collection feature of our Investment API allows you to easily configure, manage and collect the revenue charged to the end user for the services you provide.

Understand the lifecycle of a fee collection as well as how to create fee collections and work with the corresponding updates to cash balances and fee collection via sell-to-cover orders.

Read the guides

Go to the API reference

Branches

Branches In today’s dynamic business environment, companies must constantly adapt their services to meet the unique needs of their clients. Geographical diversity among user bases can significantly influence preferences, behaviours, and expectations.

Upvest provides branches feature that allow clients to tailor the services and user experiences based on specific geographical markets. By implementing location-based segmentation, our clients can provide more personalised and relevant experiences that resonate with users in different regions.

Read the guides

Go to the API reference

Valid country codes

With this release we limit the valid country codes to the ISO 3166 alpha-2 codes.

From now on only the allowed values from the enum will be accepted as valid.

Since the country code specified here applies to every endpoint of the Invesment API that uses this field, it has the advantage that these will be used compliantly and validly as of now.

Go to the API reference

Second priority identifiers

The Investment API accepts first priority user identifiers for non-CONCAT countries.

With this release, the second priority identifier can be used if the user does not have a first priority identifier, i.e. does not have a passport. For example, in the Netherlands this would be the number of the national identity card.

Read the guides

Go to the API reference

German tax exemption

We are pleased to introduce the German tax exemption feature in our Investment API, designed to simplify tax processing for German-based users. This new functionality ensures that investments qualifying for tax exemptions under German law are correctly processed and reported, offering a seamless and compliant experience for both clients and their users.

Auto-renewal for exemptions

Auto-renewal of tax exemption orders refers to the automatic extension of tax-exempt status from one year to the next without requiring any additional action by the clients. This process also simplifies the administrative burden for you and your end users that qualify for tax exemption, ensuring that their status remains active without the need for annual reapplications.

This update is now live and available for integration. Please refer to our updated API documentation for detailed implementation guidelines and support information.

Read the guides

Go to the API reference

RSS Feed available

Exciting News: RSS feed now available for Investment API releases, docs updates & News!

We are thrilled to announce the launch of our new RSS FEED feature, designed to keep you updated with everything happening on our platform - from the latest API releases to documentation updates and important news! With the ress feed, you can:

• get instant notifications of new releases
• stay informed about improvements, bug fixes, and new features
• be the first to know about documentation updates

To subscribe to our rss feed, simply visit our rss feed link and easily integrate updates into your preferred news reader or app.

Stay up-to-date with all our platform developments!

Corporate action notifications

Notifications are the first phase in the lifecycle of a corporate action. Generally, corporate actions are usually announced weeks before they become effective and settled (i.e. booking of cash and/or securities). During this period, information about the nature of a corporate action becomes available and is distributed to market participants.

The Investment API currently supports notifications for the following types of corporate actions:

• cash dividends (cash-based dividends)

• capital distributions

• shares premium dividends

If you are registered, you will receive webhooks for corporate actions in which you or your users are involved.

Read the guides

Driving licence as a valid KYC document

With this version we have added a new document_type for the KYC (Know Your Customer) check.

It is now possible for some countries to use the driving licence as an identification of persons. However, the following restriction apply:

• The driving licences cannot be submitted as a form of KYC for persons resident in Germany.

Go to the API reference

New transaction type VIRTUAL_CASH_CORRECTION

This version of the Investment API introduces the new transaction type VIRTUAL_CASH_CORRECTION.

Go to the API reference

Read the docs

We want to improve the user experience even more by assigning the relevance of the releases to the affected operating models. This allows you to see at a glance whether the message could be important for you or not.

So if the release contains functionalities or updates that have an impact in your licence model, you will see it immediately.

Here are the meanings of the badges:

The Investment API provides you with an endpoint to execute a bank transaction for testing purposes. This can be used to simulate a money transfer for various movements that require cash settlements in one of our bank accounts.

We will guide you through the process of simulating a SEPA credit transfer.

Read the docs

We have added the full list of IP addresses to our documentation that you can refer to in order to ensure frictionless work with Upvest webhooks.

Please add these IP addresses to your IP allowlist for both Live and Sandbox environments.

New transaction type TOPUP_CANCELLATION

This version of the Investment API introduces the new transaction type TOPUP_CANCELLATION.

Go to the API reference

Read the docs

Introducing our public Postman workspace for Upvest’s Investment API! 🎉

Whether you're building a new investment offering or enhancing an existing one, our Postman workspace is your gateway to discover the full potential of Upvest's Investment API.

The workspace features different collections, each tailored to our three different operating models. They form a pre-packaged set of API requests that you can import directly into your local Postman app.

One of the key advantages of using Postman is its ease of use. No more headaches from manual configuration of each API endpoint.

The collection includes all the necessary requests, headers, and parameters. Test different API endpoints and functional use cases, and see how they interact with real data.

Excited to get started? You can access the Postman workspace for the Upvest Investment API now!

Read the blogpost

We are announcing that our changelog will no longer be published with immediate effect.

This decision was made to streamline our communication channels and focus our efforts on more effective ways to keep our customers informed.

The changelog will no longer be made available, but

• detailed release notes will be available with each new version of our API, highlighting important updates, new features and bug fixes.
• comprehensive guides on important new features will be published in our documentation portal.
• You will be informed about critical updates and changes via the already known channels.

We welcome your feedback and thank you for your understanding. Our commitment to providing you with the best possible experience remains our top priority.

Transaction type TAX_REFUND

With this version of the Investment API all events that where previously reported under TAX_OPTIMISATION are now reported in the same way as the existing TAX_REFUND events.

TAX_OPTIMISATION will be discontinued with immediate effect. Although we will continue to support it, no separate events will be issued for it.

Go to the API reference

Read the docs

New transaction type

This version of the Investment API brings the new transaction type CREDIT_FUNDING_CHARGE_BACK.

Go to the API reference

Read the docs

Cancelling top-ups

You can now cancel top-ups if they have the status NEW or CONFIRMED.

To cancel an existing top-up, call the cancellation endpoint with the corresponding topup_id.

Go to the API reference

Read the docs

New transcation types

With the version 1.29.0 of the Investment API further cash and securities transactions_types have been added.

The following list the following list shows these recently added transactions_types:

• CAPITAL_DISTRIBUTION, CAPITAL_DISTRIBUTION_CANCELLATION

• SHARES_PREMIUM_DIVIDEND, SHARES_PREMIUM_DIVIDEND_CANCELLATION

• PARI_PASSU, PARI_PASSU_CANCELLATION

Go to the API reference

Read the docs

New transcation types

Version 1.28.0 of the Investment API brings two new transactions_types.

When we receive corporate action events, we will record them accordingly as positions with different creation reasons in the Financial Transactions Reporting and send the webhooks.

These two new transaction types identify transactions resulting from the conversion (or cancellation of conversion) of a corporate action.

Go to the API reference

Read the docs

New transcation type

We've added the following new transaction_type:

Go to the API reference

New tutorial on PGP keys

PGP is an encryption method that provides security and data protection for online communication. In this tutorial, we explain how PGP encryption works and how you can use it with our Investment API.

There are two main use cases where PGP keys are used with Upvest:

• Clients credentials issuing: When sharing your access credentials, this data is sent in a PGP-encrypted file.

• Encryption of files: Reporting files are transmitted in encrypted form using PGP.

Become an expert in generating PGP key pairs, as we will also show you how to create and provide the public key to us.

Read the full story about PGP Keys

New transcation types

We've added the following two new transaction_types:

Go to the API reference

New report types

In this version, we have added two new report_types.

Go to the API reference

New initiation_flow type added

With this release, we've added the initiation_flow type SAVINGS_PLAN.

When an order is created, the initiation_flow is specified; the various values for this provide you with information about what triggered the order.

Orders that were triggered by the savings plan are now also indicated.

Go to the API reference

Fee configurations available

We have added fee configurations that allow clients using our fee calculation engine to specify the fee model to be used in the calculations for a particular account.

Go to the API reference

New guide for Art.26 MiFIR Transaction reporting

In order to comply with MiFIR Art. 26, Upvest collects and stores all order execution data for each day on which our client is active. The Regulation stipulates that the relevant MiFIR reports for a given trading day must be created no later than the end of the following business day.

In this guide, we describe the steps necessary to comply with this regulation and the various use cases that depend on the respective operating models, including licences that Upvest clients are using.

Have a look here !

Release of the /files API

With the /files API, clients can securely download files via the Upvest Investment API.

Retrieving a file is a two-step process and starts with requesting a signed URL.

1. Call the /files API to request a signed URL and file metadata.

2. In the second step, use the returned signed URL to fetch data.

Find out more about this endpoint in our guide

Go to the API reference

New instruments update events

We are pleased to announce that the new instrument update events are now available in the Investment API.

Once you have registered, you will receive updates as soon as there are changes in the Upvest Trading Universe, such as:

• Instruments trading is enabled/disabled

• Fractional trading for an instrument is activated/deactivated

• Instrument data is changed.

These events are a logical extension of the GET /instruments endpoint and contain the same data.

Both endpoint and events reflect the state of the market known to Upvest.

Go to the API reference

Top-ups feature

We introduce the powerful top-ups feature, which allows users to invest as quickly as possible by increasing their available cash balance. With top-ups, users can seamlessly invest in assets without having to wait for their funds to settle, making investing more efficient and convenient.

Discover the functionality and learn how to implement it with the Investment API.

Read the docs

Go to the API reference

Additional fees information in order requests

With this release we add fees configuration to sell and buy order requests.

Example fees array for a buy order

{
      "type": "TRANSACTION_FEE_BUY",
      "value_type": "ABSOLUTE",
      "charge_method": "CHARGED_BY_CLIENT",
      "currency": "EUR",
      "cash_amount": "0.9"
}

Rebalancing execution order webhooks

We are introducing a webhook for orders created during the rebalancing process; this new webhook will reflect the status changes for rebalancing execution orders of type PORTFOLIO.

Go to the API reference

You can now use filters to refine the results list when retrieving orders for an account specified by ID.

Possible filters

Optionally, you can apply one or all of the following parameters for the operation

GET /accounts/{account_id}/orders

We are thrilled to announce the launch of our revamped Docs Portal design. This update brings a fresh and user-friendly interface to enhance user experience with our documentation resources.

Key changes and impact

• New layout and navigation
  The design introduces a more intuitive layout to streamline navigation and make it easier for users to find the information they need.

• Logical information architecture
  We’ve reorganized the information architecture to align with user expectations, ensuring that topics are logically structured and easily accessible.

• Quick access menus
  Look out for new quick access menus that allow you to jump directly to commonly used sections, saving you time and effort in your search for documentation.

We have created a new Python package from our Python code example. Customers using Python can import it directly, to start their integration up to the first authenticated call much faster.

• Code sample
• Python package

Update of the API reference navigation

We are pleased to announce that we have redesigned the navigation of the API reference to be more user-friendly.

With this concept, we are taking the approach of reorganising the endpoints and operations according to business logic and use cases.

We group the endpoints into meaningful categories that also reflect the specific applications. The navigation displays these groups clearly. This way you can find the content you are looking for faster and easier.

Have a look here !

Deleting a savings plan

With this release, it is possible to delete a savings plan configuration.

We introduce the following new endpoint for this purpose:

DELETE /savings_plans/{id}

When a savings plan is cancelled, any pending execution for it will also be cancelled (if possible). If this is not the case, we let the last execution be completed and then cancel the entire savings plan.

Account reports

Upvest provides its clients with various account metrics that can be used in the user interfaces and also to calculate custom indicators that clients require. These metrics can be accessed via specific endpoints and corresponding webhook events.

The following account-level reporting guides have been added:

• Transactions reports

• Time-weighted returns

Pre-transaction (ex-ante) cost reporting

The Investment API enables fully compliant pre-transaction cost reporting and allows its clients to embed the relevant reporting requirements into their target UI workflows.

In addition, the Investment API is fully capable of integrating clients' customised fee models in an automated manner (including AUM-based fee components as well as direct transaction costs), so that a pleasant user journey and consistent pre-transaction cost reporting can be supported.

You can find out how to work with our Investment API in the new guides:

Read the docs

Instruments API

With Upvest Investments API you have access to instrument and price data. This allows you to effectively handle specific instrument-related use cases, including the introduction of new instruments, delisting and trading bans, etc..

We have now published a detailed guide to help you understand the process of requesting instrument and price data.

We will show you step by step how to obtain instrument data and prices and how to implement business use cases for your needs.

Read the docs

Testing bank transaction flows

Normally, many of our payment flows can only be tested in conjunction with the corresponding bank transactions. While outgoing transactions are initiated by us and we can easily automate the artificial creation of bank transactions for testing payment flows, this is not so easy for flows that require incoming bank transactions such as top-ups or credit funding.

For this purpose we provide our clients with a new endpoint to create banking transactions.

See updated API reference

Savings Plan

Hurray! We’re introducing savings plan features to your favorite API !

With this version of the Upvest Investments API, you can create savings plans for individual instruments and portfolios; there is virtually no limit to the number of savings plans you can create for your users.

Read how to use our Investment API to place the first investment order for an account, including all relevant status updates. Get to know the lifecycle of savings plans and its execution states.

Learn more

Go to the API reference

New 'Know-Your-Customer' method added

With this release we have introduced the user onboarding method LIVENESS_PHOTO_ID.

With the photo KYC method, the user submits photos of their document (front and back, tilted), a selfie and a liveness video (a short video in which they turn their head to the left and right) in addition to the usual personal data such as date of birth, place of residence, geolocation point of the device and document number.

Go to the API reference

Virtual cash management

We have published a new guide on virtual cash management.

The Investment API provides a virtual cash system for tracking and managing virtual funds for your end users. Learn more about the virtual cash management feature, which enables an increase to be triggered before an order is placed and a decrease to be triggered after the order execution has been completed.

This functionality not only simplifies the complexity of tracking cash that has not yet settled, but extends additional use cases, e.g. portfolio management and rebalancing, automatic reinvestment of cash dividends, sales to cover fees and reinvestment of tax refunds.

Go to the documentation

Extension of the /instruments endpoint

We have added the following options to the /instruments endpoint:

• GET /instruments/{instrument_id}/venues
  Returns the venues where the speicified instrument is traded and for which the price data is available.

• GET /instruments/{instrument_id}/venues/{venue_id}/prices/latest
  Returns the instrument's latest price as available at the specified venue.

• GET /instruments/{instrument_id}/venues/{venue_id}/prices/ohlc
  Returns OHLC prices for the instrument at the specified venue for the chosen period.

New fields in the portfolio order object

We have added two new fields to the portfolio object:

• initiation_flow

• client_reference

Go to the API reference

User tax onboarding

The user tax onboarding function via the Investment API is now available.
Read this guide in our documentation to learn why Upvest requires additional tax-related information from users prior to account opening, what information has to be provided to Upvest and how to interact with the Investment API endpoints to achieve it.
Go to the API reference

Ex-ante reports

With this release, it is also possible to retrieve ex-ante reports for orders.

• With POST /reportsyou can create an ex-ante cost report for an order by providing the required input data:
  • order details
  • order type = ORDER_EX_ANTE_COST.

• With GET /reports/{report_id} you can retrieve reports in the following formats:
  • JSON
  • PDF

• Other improvements

  • It is now possible to specify the transaction fees for the BUY and SELL order sides separately.
  • The JSON response has been extended with some additional fields to cover all data displayed in the PDF.

Treasury report samples

We offer you some treasury report examples to view and download here.

New prerequisite when creating a user

We have another requirement when onboarding a new user:
It is not permissible to use a P.O. Box or a c/o address for the required data registration.
Read all the conditions that must be met here.

New kyc_update parameter

For customers using the "Take our license" operating model, it is now possible to send an updated KYC check by posting to the /users/{user_id}/checks endpoint with the new kyc_update parameter set to true.

This new parameter is documented here.

We now provide you with some Python and Javascript code examples, and show you how to implement V15 of the HTTP message signing mechanism and the authorisation tokens. These are needed for secure access to the Upvest Investment API.

Go to the documentation

Portfolio testing in Sandbox

Testing portfolio rebalancing is a useful way to verify the effectiveness and accuracy of rebalancing executions, while understanding the flow of events and how best to integrate this functionality into your platform.

Read the new documentation chapter on how to test portfolio rebalancing in Sandbox.

Go to the documentation

Block orders

You can now specify order requests with "execution_flow": "BLOCK" to group orders from different end users and execute them at a predefined cut-off time according to your business requirements.

For more information on this function, see our guide 'Block orders'.

Mock ISINS for block orders in Sandbox

We have activated the following mock ISINs to work with block orders in the Sandbox: IE00BKBF6H24 , IE00B3XXRP09 , DE0005933931 , IE00BK5BCH80, IE00BM8QRZ79.
Go to the documentation

We are pleased to share great and exciting news:

As of now we offer a NEWS section in our documentation portal.

Release notes

We, at Upvest are constantly working hard to make the Investment API a top class experience. Check out changes and bug fixes.

• We will introduce you to the new features we have developed or improved through our continuous development.
• We let you know when specific actions are required to continue operating smoothly with the new features or updates.
• We will inform you about bug fixes, known issues & deprecations.
• And of course, we will direct you to the relevant documentation to get all the information you need.

Changelogs

To further maximise the transparency of changes, we offer our automatically generated changelogs.

Keep an eye on the detailed diffs to understand how they differ from the previous version so that you can better adapt to a new version.