Remove relay token

POST /credit/relay/remove

The /credit/relay/remove endpoint allows you to invalidate a relay_token. The third party holding the token will no longer be able to access or refresh the reports which the relay_token gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given relay_token.

Request Body

Required

CreditRelayRemoveRequest defines the request schema for /credit/relay/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.
relay_token
required, string
The relay_token you would like to revoke.

Response

CreditRelayRemoveResponse defines the response schema for /credit/relay/remove

Response Properties

removed
required, boolean
true if the relay token was successfully removed.
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.