TRtruelayer
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

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/connections/extend
  • Auth
    OAuth 2
    Authorization code: https://auth.truelayer.com/token/connect
    Token URL: https://auth.truelayer.com/token/connect

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

The refresh token for the connection you want to extend

redirect_uristring uri required

A valid redirect URI for your TrueLayer client ID (set in 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

Changes

No recorded changes to this operation across all 1 revision of this API.