Remove an Audit Copy token

POST /credit/audit_copy_token/remove

The /credit/audit_copy_token/remove endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the audit_copy_token associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Report data and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.

Request Body

Required

CreditAuditCopyTokenRemoveRequest defines the request schema for /credit/audit_copy_token/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.
audit_copy_token
required, string
The audit_copy_token granting access to the Audit Copy you would like to revoke.

Response

CreditAuditCopyTokenRemoveResponse defines the response schema for /credit/audit_copy_token/remove

Response Properties

removed
required, boolean
true if the Audit Copy 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.