Get banks

POST

/public/v3/banks

Parameters

none

Query parameters

none

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
data	array	yes	Array of banks objects
name	string	yes	Name of the bank
slug	string	yes	Bank slug (unique identifier). You will use bank slug in many endpoints to identify bank
is_active	boolean	yes	Information if the bank is active now
country_code	string	yes	Country code. Currently only GB is supported.
type	string	yes	Bank type (Personal or Business)
is_working	boolean	yes	Flag if bank's API is responding at this moment
is_api_only	boolean	yes	Flag 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 'https://api.friendlyscore.com/public/v3/banks' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'

Response example:

{
    "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)