Exchange public token for an access token

POST /item/public_token/exchange

Exchange a Link public_token for an API access_token. Link hands off the public_token client-side via the onSuccess callback once a user has successfully created an Item. The public_token is ephemeral and expires after 30 minutes. An access_token does not expire, but can be revoked by calling /item/remove.

The response also includes an item_id that should be stored with the access_token. The item_id is used to identify an Item in a webhook. The item_id can also be retrieved by making an /item/get request.

Request Body

Required

ItemPublicTokenExchangeRequest defines the request schema for /item/public_token/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.
public_token
required, string
Your public_token, obtained from the Link onSuccess callback or /sandbox/item/public_token/create.

Response

ItemPublicTokenExchangeResponse defines the response schema for /item/public_token/exchange

Response Properties

access_token
required, string
The access token associated with the Item data is being requested for.
item_id
required, string
The item_id value of the Item associated with the returned access_token
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.