Invalidate access_token

POST /item/access_token/invalidate

By default, the access_token associated with an Item does not expire and should be stored in a persistent, secure manner.

You can use the /item/access_token/invalidate endpoint to rotate the access_token associated with an Item. The endpoint returns a new access_token and immediately invalidates the previous access_token.

Request Body

Required

ItemAccessTokenInvalidateRequest defines the request schema for /item/access_token/invalidate

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

Response

ItemAccessTokenInvalidateResponse defines the response schema for /item/access_token/invalidate

Response Properties

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