Sample - Plaid API
GET/fdx/consents

List FDX consent grants

Lists consent grants associated with a data provider customer. Supply customerId and optionally filter the results to one status value. The response contains zero or more matching consent grants.

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

2 parameters
customerIdstringrequired
The data provider customer identifier whose consent grants to list.
statusstringoptional
Filters results to one consent status: ACTIVE, REVOKED, or EXPIRED.
Allowed:ACTIVEREVOKEDEXPIRED

2 status codes
200Returns a `consent_grants` array containing grants matching the `customerId` and optional `status` filter.
consent_grantsarray<object>required
Consent grants matching the customerId (and optional status) filter.
defaultReturned when the request cannot be processed. The FDX error response contains `error_type`, `error_code`, and `error_message`.
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

customerId must be provided to identify the data provider customer whose grants you want to list. If supplied, status must be one of ACTIVE, REVOKED, or EXPIRED.