Get Accounts

GET

/public/v3/customers/{customer_id}/accounts

Parameters

Parameter	Data type	Required?	Description
customer_id	string	yes	Customer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

Parameter	Data type	Required?	Description
id	string	yes	Account ID
currency	string	yes	Currency code (compatible with ISO 4217)
name	string	no	The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSPs online channels. Note, the account name is not the product name or the nickname of the account.
is_authorized	boolean	yes	Determines if Planky is authorized to pull data for this bank account
nickname	string	no	The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.
identification	string	no	Identification assigned by an institution to identify an account. This identification is known by the account owner.
secondary_identification	string	no	This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination).
bank_slug	string	yes	Slug of the associated bank
type	string	yes	Allowed:(Business, Personal)
sub_type	string	yes	Allowed:(ChargeCard, CreditCard, CurrentAccount, EMoney, Loan, Mortgage, PrePaidCard, Savings)
number	string	yes	Account number (full Open Banking account number)
sort_code_and_account_number	Sort Code and Account Number	no	Sort code and account number. Sort code and account number are not null only when the scheme_name is set to UK.OBIE.SortCodeAccountNumber.
scheme_name	string	yes	Name of the identification scheme. For common Domestic UK identification schemes: Where "UK.OBIE.SortCodeAccountNumber" is specified as the SchemeName, the Identification field must be populated with the 6 digit Sort Code and 8 digit Account Number (a 14 digit field) Where "UK.OBIE.IBAN" is specified as the SchemeName, the Identification field must be populated with the full IBAN. Where "UK.OBIE.PAN" is specified as the SchemeName, the Identification field must be populated with the primary PAN linked to the account. An ASPSP may choose to mask digits returned in the Identification field.

Sort Code and Account Number

Parameter	Data type	Required?	Description
sort_code	int	yes	Sort Code
account_number	int	yes	Account number

Request example

1
2
3

curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/accounts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}'

Response example:

{
  "data": [
   {
            "id": 1110,
            "currency": "GBP",
            "name": "10000000000000",
            "nickname": "10000000000000",
            "identification": "10000000000000",
            "secondary_identification": null,
            "bank_slug": "fs-demo-bank",
            "type": "Business",
            "sub_type": "CurrentAccount",
            "number": "10000000000000",
            "sort_code_and_account_number": {
                "sort_code": "100000",
                "account_number": "00000000"
            },
            "scheme_name": "UK.OBIE.SortCodeAccountNumber",
            "is_authorized": true
        }
  ]
}

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)