Version 2 of the web form

We introduced a version 2 of the create TPP web-form endpoint. The version 1 is still valid and supported; however we might deprecate this endpoint in the near future.

With version 2, we introduced two major parameters, namely the

multibankingApiProvider (currently FIN_API or WEALTH_API) identifying which interface to use to connect to a bank.
the bankSlug which identifies a bank and replaces the bank ID assigned by finAPI. This change is necessary, as we plan to also support banks not listed by finAPI; one such example is the BisonAPP.

Endpoints for retrieving a web-form are still identical, but the web-form will now contain the additional fields multibankingApiProvider and bankSlug.

Web-form start URL

Banks imported via finAPI will have a different startWebFormFlowUrl than those imported via the new wealthAPI interfaces. The web-form will automatically generate the correct start URL for you; so there is most likely no change in your implementation required.

Why do we need separate web-form start URL?

The import flow for finAPI banks is far more complex than the flow for wealthAPI banks. For finAPI, there are different interfaces (finTS, XS2A, web-scraping) wheres wealthAPI does focus on brokers and will thus only have one single method to connect.

As such, a unified flow is hard to implement and we decided to provide dedicated web-forms for both scenarios.

Creating v2 web-forms

Importing a new bank

To import a new bank, you will still use the /v1/banks endpoint. The returned bank domains now contain the new fields

multibankingApiProvider (currently FIN_API or WEALTH_API)
bankSlug which identifies a bank and replaces the bank ID assigned by finAPI

When creating a new V2 web-form, these two parameters must be used. The POST body will then look like:

{
  "bankSlug": "TradeRepublic",
  "multibankingApiProvider": "WEALTH_API",
  "redirectUrl": "https://www.yourdomain.com"
}

Updating a bank connection

We recommend to always use the web-form to update a bank connection. To this end, please submit the according bankConnectionId plus the correct multibankingApiProvider in the web-form body. Both attributes are stored in the account entity. The POST body will then look like:

{
  "multibankingApiProvider": "WEALTH_API",
  "bankConnectionId": 1234,
  "redirectUrl": "https://www.yourdomain.com"
}

Updating a bank connection without the web-form

This will only work if the bank does not require 2FA. Us the GET /v1/accounts/manualSyncRequired endpoint to check if a background sync is possible. Use the web-form if unsure.

For FIN_API connections, you will start the update via the /v1/bankConnections/{id}/updateBankConnection endpoint.

For WEALTH_API connections, you must use the v3 API. Here, the flow is

Authenticate the bank connection using /api/v3/wealth_api/bank_connections/authenticate
Then update the bank connection using /api/v3/wealth_api/bank_connections with the authentication process ID as body.

Public Documentation

TPP Web Form - Version 2 released