Sign in

v1

latestOpenAPI 3.1.02026-07-2478315484.9 KB
Bank

List Banks

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

get/banks/v1

Query parameters

customer_idstring uuid
Example:f1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d

Scopes the returned banks to those enabled for the given customer. Used to control bank rollout on a per-customer basis, so that newly onboarded banks can be exposed to selected customers before being made generally available.

bank_type'RETAIL' | 'SME'

Specifies whether the bank is for retail or business (SME) customers.

Specifies whether the Entity is a Retail or Corporate owned account.

account_typesBankAccountType[]

Filters the results to banks that support at least one of the specified account types.

[
  "PERSONAL",
  "BUSINESS"
]
country_codesstring[]

Filters the results to banks located in the specified countries. Values must be alpha-3 (3 character) ISO 3166 country codes.

[
  "SAU",
  "ARE"
]
connection_typesConnectionType[]

Filters the results to banks that use one of the specified connection types.

[
  "OPEN_BANKING",
  "DIRECT_CONNECTION"
]

Headers

lean-link-sandboxstring

Indicates sandbox vs live environment

Response

List of banks

identifierstring required

The unique identifier for the bank.

namestring required

The user-friendly name of the bank.

arabic_namestring required

Arabic string for the bank name

commercial_namestring nullable

The commercial / branded name of the bank in English.

commercial_name_arabicstring nullable

The commercial / branded name of the bank in Arabic.

logostring required

A black logo for the bank.

logo_altstring required

A white logo for the bank

main_colorstring required

The hex code for the main brand colour for the bank.

background_colorstring required

The hex code for the secondary brand colour for the bank.

themestring required

Indicates the color for any overlayed text to ensure contrast

country_codestring required

The 3 letter ISO for the country the bank is located in.

swift_codestring nullable

The SWIFT/BIC code for the bank.

activeboolean required

Whether the Bank is currently operational.

mockboolean

Whether the Bank is a mock bank.

traitsstring[] required

An array of traits that are used internally to determine the type of bank connection.

supported_account_typesBankAccountSubType[] required

Indicates the account types Lean supports for this bank.

supported_account_sub_typesBankAccountSubType[]

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.

connection_type'REVERSE_ENGINEERED' | 'OPEN_BANKING' | 'DIRECT_CONNECTION'

The type of connection used by the bank for data access.

relates_tostring[] 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).