Exchange the Link Correlation Id for a Link Token

POST /link/oauth/correlation_id/exchange

Exchange an OAuth link_correlation_id for the corresponding link_token. The link_correlation_id is only available for payment_initiation products and is provided to the client via the OAuth redirect_uri as a query parameter. The link_correlation_id is ephemeral and expires in a brief period, after which it can no longer be exchanged for the link_token.

Request Body

Required

LinkOAuthCorrelationIdExchangeRequest defines the request schema for /link/oauth/correlation_id/exchange

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
link_correlation_id
required, string
A link_correlation_id from a received OAuth redirect URI callback

Response

LinkOAuthCorrelationIdExchangeResponse defines the response schema for /link/oauth/correlation_id/exchange

Response Properties

link_token
required, string
The link_token associated to the given link_correlation_id, which can be used to re-initialize Link.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.