This feature is only available in the UK
Extending a connection is only supported for UK users. For users in the EU, you need to use a
refresh_tokenor reauthenticate with a new
access_tokenfor ongoing access to user data.
After creating a connection, you have access to your user’s account information. However, a connection isn’t active forever. You need to extend a connection regularly if you need ongoing access to your user’s account information.
Ensuring that you have a valid and active consent and a valid and active authentication for your user is a complex process with various contributing factors.
To handle this complexity, the simplest way to begin to extend the connection is to call the
/connections/extend endpoint. This allows TrueLayer to select the user experience with the least friction when extending the connection.
To extend a connection, you need to build your own reconfirmation of consent process that the user reconfirms consent with 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.
We recommend using the
connections/extend endpoint to extend a connection. It supersedes the
Always avoid creating an entirely new connection when authentication expires. Instead, use
connections/extend to obtain a new authorisation for the existing connection. This avoids double billing within a single month.
Updated about 1 month ago