Get banks





Query parameters


Request Body Parameters


Response Body Parameters

ParameterData typeRequired?Description
dataarrayyesArray of banks objects
namestringyesName of the bank
slugstringyesBank slug (unique identifier). You will use bank slug in many endpoints to identify bank
is_activebooleanyesInformation if the bank is active now
country_codestringyesCountry code. Currently only GB is supported.
typestringyesBank type (Personal or Business)
is_workingbooleanyesFlag if bank's API is responding at this moment
is_api_onlybooleanyesFlag if bank is available only via the API (Connectivity is not available). You can post your data to this kind of banks.

Request example

1 2 3 curl --location --request GET '' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {access_token}'

Response example:

1 2 3 4 5 6 7 8 9 10 11 12 { "data": [ { "name": "Barclays", "slug": "barclays", "is_active": true, "country_code": "GB", "type": "Personal", "is_working": true, "is_api_only": false } }

Was this article helpful?

Friendly Score UK Ltd.

84 Brook Street

London W1K 5EH

Call us on +44 20 3709 6726

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)