---
title: "List FDX Consent Grants for a customer"
method: GET
path: "/fdx/consents"
tags: ["plaid"]
---

# List FDX Consent Grants for a customer

`GET /fdx/consents`

Returns zero or more consent grants associated with the given data provider customer, optionally filtered by status.

## Query parameters

- `customerId` string, required
- `status` 'ACTIVE' | 'REVOKED' | 'EXPIRED' — Current status of a consent grant. One of `ACTIVE`, `REVOKED`, `EXPIRED`.

## Response `200`

OK

- GetConsentsResponse — GetConsentsResponse defines the response schema for `/fdx/consents`
  - `consent_grants` FDXConsentGrant[], required — Consent grants matching the customerId (and optional status) filter.
    - `id` string, required — The persistent identifier of the consent grant
    - `status` 'ACTIVE' | 'REVOKED' | 'EXPIRED', required — Current status of a consent grant. One of `ACTIVE`, `REVOKED`, `EXPIRED`.
    - `createdTime` string, date-time, required — When the consent was initially granted
    - `updatedTime` string, date-time, required — When the consent grant was last updated
    - `expirationTime` string, date-time — When the consent grant will expire. Omitted when the grant has no expiration.
    - `parties` FDXParty[], required — Non-end-user parties participating in the consent grant (Data Recipient, Data Provider, Data Access Platform).
      - `name` string, required — Human recognizable common name
      - `type` 'DATA_ACCESS_PLATFORM' | 'DATA_PROVIDER' | 'DATA_RECIPIENT' | 'INDIVIDUAL' | 'MERCHANT' | 'VENDOR', required — Identifies the type of a party
      - `homeUri` string, uri — URI for party, where an end user could learn more about the company or application involved in the data sharing chain
      - `logoUri` string, uri — URI for a logo asset to be displayed to the end user
      - `registry` 'FDX' | 'GLEIF' | 'ICANN' | 'PRIVATE' — The registry containing the party's registration with name and id
      - `registeredEntityName` string — Registered name of party
      - `registeredEntityId` string — Registered id of party
    - `resources` FDXConsentGrantResource[] — Permissioned resource entries. Omitted when there are no resources.
      - `resourceType` 'ACCOUNT' | 'CUSTOMER' | 'DOCUMENT', required — Type of resource permissioned on a consent grant.
      - `resourceId` string, required — Identifier of the resource permissioned.
      - `dataClusters` FDXDataCluster[], required — Names of clusters of data elements permissioned.

## Other responses

- `default` — Error response

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)