Link parameters

Giving you total control over the Link component

When redirecting the user to our Link solution, there are some parameters that can be included in the URI to perform certain actions. Depending on if you are starting a new connection or just updating an existing one, you have several options.

New connections

New connections can instantiate the Link in two different ways, subject to the option to force authToken usage is active or not. If the option is not active, then you can choose between both approaches freely. If the option is active, only the authToken approach is available for your Link, and trying to not use it will result in a controlled unauthorized error. Check how you can activate this option.

Forcing API connection

When forcing a new connection through the Link using an authToken, you have to include it as a parameter. The accepted parameters are:

  • authToken*: it is a JWT token that you can obtain from the API link authentication endpoint. You can check the body and needed data for requesting an authToken, but to sum up, you can basically configure everything as you would do in a flow without using an authToken.

  • Other parameters: see Common parameters section in this same page to check other accepted parameters.

Without forcing authToken usage

These are the allowed parameters:

  • id*: this should be the redirect token that you can find in the Link redirects table. It helps us identify your app and associate the connection being made to it. It should always be included, even when performing an update to a connection.

  • external_id: you can include this parameter in order to assign an external_id to a connection. This is useful to relate different connections together. When querying connections, you can include this parameter to get all connections related to an external_id.

  • subproduct: using the product of assets transfer, you only can transfer pension plans or funds at once. So in order to choose one of those, you must add this parameter with PP or FUND.

  • Other parameters: see Common parameters section in this same page to check other accepted parameters.

Connection updates or restores

Apart from using the Link for new connections, you can also use it to launch a restore or update flow. In those cases, there is no option of using the authToken, because updates and restores use a specific UUID token that is only valid once and serves to uniquely identify the connection. Since the connection parameters were already decided in the first connection, you can't update them now. These would be the accepted parameters:

  • update_token: this is a token that you will receive inside the connection status response. It is a token you can use to manually update a connection. This is most important for connections with MFA, that can't be updated automatically. When you want to start an update flow, just include the update_token you have received in the credentials status and we'll take care of everything else.

  • restore_token: similar to the update_token, but in this case the token will appear if a connection is either blocked (needs to be unblocked outside of our systems), needs a user action (like confirming some data) or the credentials of the account have changed. By including a valid restore_token, a flow to unblock or update credentials in our system will be launched.

  • Other parameters: see Common parameters section in this same page to check other accepted parameters.

Common parameters

This parameters can be used in both options:

  • themeType: this option allows you to select between LIGHT and DARK themes. You can configure both themes to match your brand. Learn more about it here.

  • entity: by including this parameter, you can make the flow skip the financial entity selection list in a new connection. This means that the flow will jump directly to the login of the entity you have passed down. It should be a valid entity returned from the GET entities endpoint.

  • locale: you can add this parameter to make all proccess in Spanish (es_ES) or English (en).

URI Builder

To make things easier, we have included a fast base Link URL creator into your apps. Go to the desired Product in your menu and the into the Create URL tab. As you can see below, just select the Languge, Redirect URL and theme that you want for the Link. This will give you a valid Link to quickly start using it in your application.

Last updated