Extend a connection

After creating a connection, you have access to your user’s account information. However, a connection isn’t active forever. You will need to extend a connection regularly if you require on going access to your user’s account information.

Ensuring that you both have a valid and active consent as well as a valid and active authentication for your user is a complex process with a variety of contributing factors.

To handle this complexity, calling the connections/extend endpoint is the simplest way to start the process of extending the connection. This allows TrueLayer to select the user experience with the least friction when extending the connection.

Currently, extending a connection requires you to have built your own reconfirmation of consent process that the user reconfirms consent before calling connections/extend. This is confirmed by passing in user_has_reconfirmed_consent: true when making a request.

📘

Reconfirmation of consent UX

We recommend that you design your own reconfirmation of consent UX. The design should follow the same principles as the UX for the initial confirmation of consent. See Reconfirmation UX for more guidance.

Recommended endpoint

The connections/extend endpoint is the recommended approach to extending a connection. It supersedes the /reauthuri endpoint.

You should always avoid creating an entirely new connection when authentication expires and instead use connections/extend to obtain a new authorisation for the existing connection. This avoids double billing within a single month.


Did this page help you?