Item

itemPublicTokenExchange

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.

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.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

ItemPublicTokenExchangeRequest defines the request schema for /item/public_token/exchange

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*string

Your public_token, obtained from the Link onSuccess callback or /sandbox/item/public_token/create.

Response Body

application/json

curl -X POST "https://example.com/item/public_token/exchange" \  -H "Content-Type: application/json" \  -d '{    "public_token": "string"  }'
{  "access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",  "item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",  "request_id": "Aim3b"}