Extend a connection

post

https://api.truelayer-sandbox.com/connections/extend

Starts a process to extend a connection, by reconfirming consent and starting a new authentication if necessary.
You can find out more on how to use this endpoint here.

Body Params

user_has_reconfirmed_consent

boolean

required

Set to true if the user has re-confirmed consent in your application. We must review your consent screen and enable your client ID before you can set this field to true in production.

Set to false if you'd like the user to re-confirm consent in TrueLayer's auth dialog (setting to false is currently not supported).

client_id

string

required

Your application's client ID, found in TrueLayer Console

client_secret

string

required

Your application's client secret, found in TrueLayer Console

user

object

required

Details of the end user who is connecting to their provider.

refresh_token

string

required

The refresh token for the connection you want to extend

redirect_uri

uri

required

A valid redirect URI for your TrueLayer client ID (set in Console)

state

string

An opaque value used by the client to maintain state between the request and callback

code_challenge

string

PKCE code challenge

response_mode

string

enum

If set to form_post, when we call your redirect URI, we'll include the code in a form POST request. If left unset, we'll make a GET request with the code set as a query parameter

Allowed:

Headers

X-Client-Correlation-Id

string

Client-specified ID used to debug requests

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Extend response

400Validation error response

401Unauthorised

422Unprocessable Entity