---
title: "List Banks"
method: GET
path: "/banks/v1"
tags: ["Bank"]
---

# List Banks

`GET /banks/v1`

Fetch a list of all supported Banks for your application, includes status and configuration information.

## Query parameters

- `customer_id` string, uuid
- `bank_type` 'RETAIL' | 'SME' — Specifies whether the bank is for retail or business (SME) customers.
- `account_types` BankAccountType[]
- `country_codes` string[]
- `connection_types` ConnectionType[]

## Headers

- `lean-link-sandbox` string

## Response `200`

List of banks

- Bank[]
  - `identifier` string, required — The unique identifier for the bank.
  - `name` string, required — The user-friendly name of the bank.
  - `arabic_name` string, required — Arabic string for the bank name
  - `commercial_name` string, nullable — The commercial / branded name of the bank in English.
  - `commercial_name_arabic` string, nullable — The commercial / branded name of the bank in Arabic.
  - `logo` string, required — A black logo for the bank.
  - `logo_alt` string, required — A white logo for the bank
  - `main_color` string, required — The hex code for the main brand colour for the bank.
  - `background_color` string, required — The hex code for the secondary brand colour for the bank.
  - `theme` string, required — Indicates the color for any overlayed text to ensure contrast
  - `country_code` string, required — The 3 letter ISO for the country the bank is located in.
  - `swift_code` string, nullable — The SWIFT/BIC code for the bank.
  - `active` boolean, required — Whether the Bank is currently operational.
  - `mock` boolean — Whether the Bank is a mock bank.
  - `traits` string[], required — An array of traits that are used internally to determine the type of bank connection.
  - `supported_account_types` BankAccountSubType[], required — Indicates the account types Lean supports for this bank.
  - `supported_account_sub_types` BankAccountSubType[] — Indicates the account sub-types Lean supports for this bank.
  - `bank_type` 'RETAIL' | 'SME' — Specifies whether the bank is for retail or business (SME) customers.
  - `transfer_limits` TransferLimit[], required — An array of key-value pairs for supported currencies and their associated transfer limits with the bank.
    - `currency` string, required — The ISO 4217 currency code for the currency.
    - `min` number, required — The minimum supported transfer amount.
    - `max` number, required — The maximum supported transfer amount.
  - `international_transfer_limits` TransferLimit[], required — A list of objects representing the limits for transactions to international destinations. These limits apply to all transfers to international payments.
    - `currency` string, required — The ISO 4217 currency code for the currency.
    - `min` number, required — The minimum supported transfer amount.
    - `max` number, required — The maximum supported transfer amount.
  - `international_destinations` object[], required — A list of objects representing international destinations to where Lean can initiate international payments for this bank.
    - `country_iso_code` string — The alpha-3 (3 character) ISO 3166 country code for the destination country the bank can initiate transactions to.
    - `country_name` string — The name of the destination country the bank can initiate transactions to.
    - `supported_currencies` string[] — A list of supported currencies the bank can initiate transactions to that destination
  - `connection_type` 'REVERSE_ENGINEERED' | 'OPEN_BANKING' | 'DIRECT_CONNECTION' — The type of connection used by the bank for data access.
  - `relates_to` string[], nullable — Identifiers of related banks. Used to pair an Open Banking bank with its reverse-engineered counterpart (and vice versa) when the same institution is reachable via both connection types.
  - `account_type` 'PERSONAL' | 'BUSINESS' — Specifies the type of account (PERSONAL or BUSINESS).
  - `availability` BankAvailability, required — Whether the Bank is currently available for use with the Payments and Data API. Changes to this status trigger banks.availability.updated webhooks.
    - `active` object, required — Whether Lean has enabled the or disabled the Bank for Payments and Data functionality. When this is false, Lean has taken the bank offline due to stability, maintenance or regulatory reasons.
      - `payments` boolean, required
      - `data` boolean, required
    - `enabled` object, required — Whether the bank has been enabled in the application dashboard or not. If you want to hide a bank or disable it from use for any reason - you can log in to the [Application Dashboard](https://dev.leantech.me) to enable and disable visibility and functionality of a bank on your platform.
      - `payments` boolean, required
      - `data` boolean, required

---

[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)