API Reference
Asset librariesConsole

Extend a connection

post
https://api.truelayer-sandbox.com/data/v1/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
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).

string
required

Your application's client id, found in TrueLayer Console

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.

string
required

refresh_token for the connection you want to extend

uri
required

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

string

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

string

PKCE code challenge

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
string

Client-specified ID used to debug requests

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated about 1 month ago