Sample - Plaid API
GET/fdx/consents/{consentId}

Get an FDX consent grant

Retrieves an FDX consent grant by its identifier. Supply consentId to obtain the grant's status, timestamps, participating parties, and permissioned resources. Optional expiration and resource data is omitted when it does not apply.

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

1 parameter
consentIdstringrequired
The unique identifier of the consent grant to retrieve.

2 status codes
200Returns the consent grant with its identifier, status, creation and update timestamps, participating parties, and any permissioned resources.
idstringrequired
The persistent identifier of the consent grant
statusstringrequired
Current status of a consent grant. One of `ACTIVE`, `REVOKED`, `EXPIRED`.
Allowed:ACTIVEREVOKEDEXPIRED
createdTimestringrequired
When the consent was initially granted
updatedTimestringrequired
When the consent grant was last updated
expirationTimestringoptional
When the consent grant will expire. Omitted when the grant has no expiration.
partiesarray<PartyEntity>required
Non-end-user parties participating in the consent grant (Data Recipient, Data Provider, Data Access Platform).
resourcesarray<object>optional
Permissioned resource entries. Omitted when there are no resources.
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

consentId must identify the consent grant to retrieve. Consent status values are limited to ACTIVE, REVOKED, and EXPIRED, and consent timestamps use ISO 8601 date-time format.