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.
Version 1.43.0 release
Corporate actions notification: New types
The Investment API now supports corporate action notifications of the following types:
- Intermediate securities distribution
- Dividend option
Version 1.42.0 release
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"
}
]New guide for fees collection via the Investment API
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.
Version 1.41.0 release
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.
Version 1.40.0 release
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.
Version 1.39.0 release
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.
Version 1.38.0 release
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.
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!
Version 1.37.0 release
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
Further corporate action types will successively follow.
If you are registered, you will receive webhooks for corporate actions in which you or your users are involved.
Version 1.36.0 release
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.
Version 1.35.0 release
This version of the Investment API introduces the new transaction type VIRTUAL_CASH_CORRECTION.
| Transaction type | Description |
|---|---|
VIRTUAL_CASH_CORRECTION | You will receive a webhook event of this type when a virtual cash correction has been made. |
Release notes with operating model specification
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:
| Operating Models | |
|---|---|
| TOL | Take our license - Single Accounts |
| BYOL | Bring your own license - Single Accounts |
| OMNIBUS | Bring your own license - Omnibus |
New guide for SEPA credit transfer testing
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.
IP addresses
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 allow list for both Live and Sandbox environments.
Version 1.33.0 release
This version of the Investment API introduces the new transaction type TOPUP_CANCELLATION.
| Transaction type | Description |
|---|---|
TOPUP_CANCELLATION | You receive a webhook event of this type when a topup has been cancelled. |
Public Postman workspace for Upvest’s Investment API!
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!
Discontinuation of changelog
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.
Version 1.32.0 release
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.
Please note that no action is required as all previous events of the type TAX_OPTIMISATION remain accessible and there is no change in the reporting of tax events. It is simply a matter of combining TAX_REFUND and TAX_OPTIMISATION into one event.
Version 1.31.0 release
This version of the Investment API brings the new transaction type CREDIT_FUNDING_CHARGE_BACK.
| Transaction type | Description |
|---|---|
CREDIT_FUNDING_CHARGE_BACK | You receive a webhook event of this type when a chargeback of the credit financing has taken place. |
Version 1.30.0 release
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.
Version 1.29.0 release
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_CANCELLATIONSHARES_PREMIUM_DIVIDEND,SHARES_PREMIUM_DIVIDEND_CANCELLATIONPARI_PASSU,PARI_PASSU_CANCELLATION
Version 1.28.0 release
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.
| Transaction type | Description |
|---|---|
CONVERSION | You receive a webhook event of this type when a securities or cash transaction is triggered by the corporate action event. |
CONVERSION_CANCELLATION | You receive a webhook event of this type if a securities or cash transaction has been cancelled by the corporate action event. |
Version 1.27.0 release
We've added the following new transaction_type:
| Transaction type | Description |
|---|---|
SECURITIES_TRANSFER_CANCELLATION | You will receive a webhook event of this type when a securities transfer correction has been made. |
Docs update
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.
Version 1.26.0 release
We've added the following two new transaction_types:
| Transaction type | Description |
|---|---|
BALANCE_CORRECTION | You will receive a webhook event of this type when a balance correction has been made. |
BALANCE_CORRECTION_CANCELLATION | You will receive a webhook event of this type if the original balance correction was incorrect and had to be cancelled. |
Version 1.25.0 release
In this version, we have added two new report_types.
| Report type | Description |
|---|---|
CORPORATE_ACTION_CASH_TRANSACTION | You will receive a webhook event of this type when a report was created for cash transactions that take place after a corporate action. |
CORPORATE_ACTION_SECURITY_TRANSACTION | You will receive a webhook event of this type when a report was created for securities transactions that take place after a corporate action. |
Version 1.24.0 release
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.
Version 1.23.0 release
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.
Docs update
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.
Version 1.22.0 release
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.
Call the
/filesAPI to request a signed URL and file metadata.In the second step, use the returned signed URL to fetch data.
Version 1.21.0 release
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.
Please note that this webhook does not filter out the instruments that your users trade, so you will receive updates for the entire Upvest trading universe.
If you would like to activate the newly added instrument for your users, please contact us first.
Version 1.20.0 release
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.
Version 1.19.0 release
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"
}| Parameter | Description | Example |
|---|---|---|
type | Required: The order type for which the fee is to be charged. Possible values: - TRANSACTION_FEE_BUY - TRANSACTION_FEE_SELL | TRANSACTION_FEE_BUY |
value_type | Required: Only absolute fees are possible. | ABSOLUTE |
charge_method | Required: Indicates whether the fee is charged to the client or by other methods. | CHARGED_BY_CLIENTS |
currency | Required: The currency in which the fee is charged. Alphabetic three-letter ISO 4217 currency code. | EUR |
cash_amount | Required: The fee amount that is charged. |
Version 1.18.0 release
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.
Filtering results when listing orders of an account
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
| Filter | Description | Example value |
|---|---|---|
account_group_id | The ID of the account group to be filtered by. | debf2026-f2da-4ff0-bb84-92e45babb1e3 |
user_id | The ID of the user to be filtered by. | 2dedfeb0-58cd-44f2-ae08-0e41fe0413d9 |
status | The status of the order to be filtered by. | FILLED |
date_created_from | The creation date from which to filter. | 2024-01-01T07:00:00Z (the Z means it's UTC) |
date_created_to | The date up to which filtering is to be applied. | 2024-01-031T20:00:00Z (the Z means it's UTC) |
New documentation portal design
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.
Updated URLs
With the new design, some URL structures have changed. Please update your bookmarks accordingly!
Signature code sample: New Python Package
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.
Docs update
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.
Version 1.17.0 release
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.
We keep the history of this savings plan and its executions after the cancellation.
Docs update
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:
Docs update
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:
Docs update
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.
Version 1.16.0 release
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.
Version 1.15.0 release
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.
Version 1.12.0 release
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.
Please note that this method is only supported outside of Germany due to compliance with anti-money laundering laws in Germany.
You can only onboard users whose place of residence is NOT in Germany by this method.
Docs update
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.
Version 1.11.0 release
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.
We have added two new fields to the portfolio object:
initiation_flowclient_reference
| Parameter | Description |
|---|---|
inition_flow | Possible values: * API * SAVINGS_PLAN This way it is distinguished where the portfolio order came from. |
client_reference | This field is empty if the portfolio order is created via API. It contains the savings_plan_id if portfolio order is created via a savings plan. |
Version 1.10.0 release
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
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.
Currently only ex-ante cost reporting for nominal and unit orders is supported (support for LIMITand STOP orders will be added soon).
- With GET
/reports/{report_id}you can retrieve reports in the following formats:- JSON
It is possible that the creation of the PDF report will take a little more time than the report creation response, and if needed you can use webhooks REPORT.CREATED to confirm that the PDF report has been created.
Other improvements
It is now possible to specify the transaction fees for the
BUYandSELLorder sides separately.The JSON response has been extended with some additional fields to cover all data displayed in the PDF.
Version 1.09.0 release
Version 1.08.0 release
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.
Signature code samples
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.
Docs update
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.
Version 1.05.0 release
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'.
We have activated the following mock ISINs to work with block orders in the Sandbox: IE00BKBF6H24 , IE00B3XXRP09 , DE0005933931 , IE00BK5BCH80, IE00BM8QRZ79.
Big news!
We are pleased to share great and exciting news:
As of now we offer a NEWS section in our documentation portal.
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.
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.