Remove an Item

POST /item/remove

The /item/remove endpoint allows you to remove an Item. Once removed, the access_token, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item.

Calling /item/remove is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling /item/remove is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via https://my.plaid.com/). For more details, see Subscription fee model.

In Limited Production, calling /item/remove does not impact the number of remaining Limited Production Items you have available.

Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the /asset_report/remove endpoint.

Also note that for certain OAuth-based institutions, an Item removed via /item/remove may still show as an active connection in the institution's OAuth permission manager.

API versions 2019-05-29 and earlier return a removed boolean as part of the response.

Request Body

Required

ItemRemoveRequest defines the request schema for /item/remove

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.
reason_code
string
The reason for removing the item FRAUD_FIRST_PARTY: The end user who owns the connected bank account committed fraud FRAUD_FALSE_IDENTITY: The end user created the connection using false identity information or stolen credentials FRAUD_ABUSE: The end user is abusing the client’s service or platform through their connected account FRAUD_OTHER: Other fraud-related reasons involving the end user not covered by the specific fraud categories CONNECTION_IS_NON_FUNCTIONAL: The connection to the end user’s financial institution is broken and cannot be restored OTHER: Any other reason for removing the connection not covered by the above categories
reason_note
string
Additional context or details about the reason for removing the item. Personally identifiable information, such as an email address or phone number, should not be included in the reason_note.

Response

ItemRemoveResponse defines the response schema for /item/remove

Response Properties

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.