Sign in

v1

latestOpenAPI 3.0.32026-07-2484569553.1 KB
Connection Management

Extend a connection

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.

post/connections/extend

Headers

X-Client-Correlation-Idstring

Client-specified ID used to debug requests

Request body

user_has_reconfirmed_consentboolean 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_idstring required

Your application's client id, found in TrueLayer Console

client_secretstring required

Your application's client secret, found in TrueLayer Console

refresh_tokenstring required

refresh_token for the connection you want to extend

redirect_uristring uri required

A valid redirect_uri for your TrueLayer client_id (set in your Console)

statestring

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

code_challengestring

PKCE code challenge

response_mode'form_post'

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

Example request

{
  "client_id": "budgetapp-b4c334",
  "user": {
    "name": "Alan Turing",
    "email": "alan@example.org",
    "phone": "+437777777777"
  }
}

Response

Extend response

OR
OR