Sample - Plaid API
PUT/fdx/consents/{consentId}/revocation

Revoke FDX consent grant

Revokes a consent grant, ending the data recipient's ongoing access to the customer's data.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 4 body fields
consentIdstringrequired
Unique identifier of the consent grant.
initiatorstringrequired
Identifies the type of a party
Allowed:DATA_ACCESS_PLATFORMDATA_PROVIDERDATA_RECIPIENTINDIVIDUALMERCHANTVENDOR
reasonstringrequired
Reason for lifecycle event status change
Allowed:BUSINESS_RULESECURITY_EVENTUSER_ACTIONOTHER
otherReasonstringoptional
Additional information or description of an `OTHER` reason
updatedTimestringoptional
When the revocation was effected on the initiator's side

2 status codes
204No Content
defaultError response
error_typestringrequired
Broad categorization of the error. Stable, and safe for programmatic use. Common values are `BAD_REQUEST`, `NOT_FOUND`, `CONFLICT`, and `INTERNAL_SERVER_ERROR`.
error_codestringrequired
The particular error code. Stable, and safe for programmatic use. For example `32` for a malformed request, `1107` when the consent grant is not found, `409` when the grant is already in a terminal state, and `01` for an internal error.
error_messagestringrequired
A developer-friendly description of the error code. Subject to change, so it is not safe for programmatic use.

Error handling

Any other status is an error: Error response.