---
title: "List scheme identifiers"
method: GET
path: "/scheme_identifiers"
tags: ["Scheme Identifier"]
---

# List scheme identifiers

`GET /scheme_identifiers`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/scheme_identifiers`
- Auth: HTTP bearer

Returns a [cursor-paginated](https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination) list of your scheme identifiers.

## Query parameters

- `before` string, nullable
- `after` string, nullable
- `limit` union
  - integer
  - string
- `creditor` string: Unique identifier, beginning with "CR".

## Headers

- `GoCardless-Version` string, required

## Response `200`

Successful response

- SchemeIdentifierMultiResourceResponse
  - `scheme_identifiers` SchemeIdentifier[]
    - `id` string, required: Unique identifier, usually beginning with "SU".
    - `created_at` string, date-time, required: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
    - `name` string, required: The name which appears on customers' bank statements. This should usually be the merchant's trading name.
    - `scheme` 'ach' | 'autogiro' | 'bacs' | 'becs' | 'becs_nz' | 'betalingsservice' | 'faster_payments' | 'pad' | 'pay_to' | 'sepa' | 'sepa_credit_transfer' | 'sepa_instant_credit_transfer', required: The scheme which this scheme identifier applies to.
    - `reference` string, nullable, required: The scheme-unique identifier against which payments are submitted.
    - `status` 'pending' | 'active', required: The status of the scheme identifier. Only `active` scheme identifiers will be applied to a creditor and used against payments.
    - `minimum_advance_notice` integer, required: The minimum interval, in working days, between the sending of a pre-notification to the customer, and the charge date of a payment using this scheme identifier. By default, GoCardless sends these notifications automatically. Please see our [compliance requirements](https://docs.gocardless.com/docs/api-reference/compliance-requirements) for more details.
    - `can_specify_mandate_reference` boolean, required: Whether a custom reference can be submitted for mandates using this scheme identifier.
    - `currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', required: The currency of the scheme identifier.
    - `address_line1` string, nullable, required: The first line of the scheme identifier's support address.
    - `address_line2` string, nullable, required: The second line of the scheme identifier's support address.
    - `address_line3` string, nullable, required: The third line of the scheme identifier's support address.
    - `city` string, nullable, required: The city of the scheme identifier's support address.
    - `region` string, nullable, required: The scheme identifier's support address region, county or department.
    - `postal_code` string, nullable, required: The scheme identifier's support postal code.
    - `country_code` string, nullable, required: [ISO 3166-1 alpha-2 code.](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
    - `email` string, nullable, required: Scheme identifier's support email address.
    - `phone_number` string, nullable, required: Scheme identifier's support phone number.
  - `meta` SchemeIdentifierPaginationMeta: Cursor pagination information
    - `limit` integer, required
    - `cursors` object, required
      - `before` string, nullable, required: Cursor pointing to the end of the desired set.
      - `after` string, nullable, required: Cursor pointing to the start of the desired set.

## Other responses

- `400`: Bad Request
- `401`: Unauthorised
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)