---
title: "List customers consents"
method: GET
path: "/consents/v1"
tags: ["Consents"]
---

# List customers consents

`GET /consents/v1`

Retrieves a paginated list of payment consents for the specified customer.

## Query parameters

- `customer_id` string, uuid, required
- `status` ConsentStatus[] — Optional list of consent statuses to filter by
- `page_number` integer
- `page_size` integer

## Response `200`

OK

- ListPaymentConsentsResponse
  - `data` GetPaymentConsentResponse[], required
    - `consent_id` string, uuid, required — The unique identifier for the consent. Provided as a UUID.
    - `bank_identifier` string, nullable — The identifier of the bank used to authorize this consent. Returns null if the consent has not been authorized.
    - `application_id` string, required — The application associated with the consent
    - `start_date_time` string, date-time, required — Date and time from when the consent will be active
    - `expiration_date_time` string, date-time, required — Date and time of the expiration of this consent
    - `customer_id` string, uuid, required — Identifies which Customer owns the consent
    - `status` 'AWAITING_AUTHORISATION' | 'AUTHORISED' | 'REVOKED' | 'REJECTED' | 'EXPIRED' | 'CONSUMED' | 'SUSPENDED', required — Current status of this consent.
    - `destination_account_id` string, uuid, required — Account id that this consent allows payments to
    - `sender_account_id` string, uuid, nullable — Account id from which payments are made under this consent. Returns null if the consent has not been authorized.
    - `reference` string, required — A reason or reference in relation to a payment. Passed as a part of OF `creditor_reference`. This value will be used as default reference for payments made with this consent.
    - `consented_account` ConsentedAccount
      - `iban` string — Consented account IBAN number.
      - `holder_name` string — Consented account holder name.
    - `currency` string, required — The ISO 3 letter currency code
    - `payment_purpose` PaymentPurpose, required — Indicates the reason for the payment using a standardized code and human-readable description.
      - `code` 'FIS' | 'TCS' | 'MWP' | 'OAT' | 'IFS' | 'RNT' | 'LNC' | 'PIN' | 'GDS', required — A category code that relates to the type of services or goods that corresponds to the underlying purpose of the payment. The code must conform to the payment purpose code list. **Supported values:** - `FIS` – Financial services - `TCS` – Telecommunication services - `MWP` – Mobile wallet card payments - `OAT` – Own account transfer - `IFS` – Information services - `RNT` – Rent payments - `LNC` – Loan charges - `PIN` – Personal investments - `GDS` – Goods bought or sold
      - `description` string, required — A human-readable description of payment purpose
    - `control_parameters` ControlParameters, required — Defines the control parameters for a Account On File (AoF) consent. These parameters specify the applicable limits for individual payments, cumulative amounts, and the number of payments allowed within a defined period or across the consent's lifetime. At least one of `max_individual_amount`, `max_cumulative_amount`, or `max_cumulative_number_of_payments` must be provided.
      - `type` string, required — Discriminator type identifying the control parameters variant
      - `period_type` 'Day' | 'Week' | 'Month' | 'Year', required — Defines the time period used for applying limits on a long‑lived consent. This value determines how consumption limits (e.g., maximum amounts or number of payments) are calculated within each period. **Supported values:** - `Day` – A single calendar day (00:00 to 23:59). - `Week` – Seven consecutive days. - `Month` – A full calendar month (from the 1st to the last day). - `Year` – A full calendar year (12 consecutive months).
      - `max_individual_amount` number — Maximum amount allowed for a single payment
      - `max_cumulative_amount` number — Maximum cumulative amount allowed across all payments
      - `max_cumulative_number_of_payments` integer — Maximum number of payments allowed in total
      - `max_cumulative_amount_per_period` number — Maximum cumulative amount allowed per period
      - `max_cumulative_number_of_payments_per_period` integer — Maximum number of payments allowed per period
    - `payment_consumption` object, nullable — Current state of consent consumption (if available)
      - `cumulative_number_of_payments` integer — The cumulative number of payment instructions initiated under the consent schedule, excluding instructions in a Rejected state.
      - `cumulative_value_of_payments` number, double — The cumulative value of payment instructions initiated under the consent schedule, excluding instructions in a Rejected state."
      - `cumulative_number_of_payments_in_current_period` integer — The cumulative number of payment instructions in the current period initiated under the consent schedule, excluding instructions in a Rejected state.
      - `cumulative_value_of_payments_in_current_period` number, double — The cumulative value of payment instructions in the current period initiated under the consent schedule, excluding instructions in a Rejected state.
    - `immediate_payment` ImmediatePayment, nullable — Details of a payment that will be executed immediately after the user successfully authorizes the consent. If present, the payment is initiated automatically as part of the consent authorization flow.
      - `amount` number, required — The amount to be paid immediately upon consent authorization
      - `reference` string — A reason or reference in relation to a payment. Maximum 64 chars
      - `creditor_reference` string, nullable — Clients identifier that can be used in their ERP systems
  - `page` PageMetadata, required — Metadata about the current page of results
    - `number` integer, required — The current page being returned by the API
    - `size` integer, required — The page size requested
    - `total_elements` integer, required — The total number of elements in all pages
    - `total_pages` integer, required — The total number of pages retrievable
    - `sort` string[] — Sort parameters applied to the results

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)