Get Personal Affordability

GET

/public/v3/customers/{customer_id}/affordability/personal

Returns monthly affordability amount for personal bank accounts. Affordability is based on the last 12 months window and excludes transactions from current month. Affordability calculation does not consider payday loans or any loan income.

If you need different time window, for example 3 months, it is available in our Enterprise product. Please contact us.

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
yearintegeryesYear
monthintegeryesMonth
amountfloatyesMonthly affordability amount
currencystringyesCurrency
affordability_typestringyesTime window used for calculations. By default it is a 12 months window (type: TWELVE_MONTH).
account_typestringyesBank Account Type. Only Personal bank accounts are supported.

Request example

1 2 3 curl --location --request GET 'https://api.friendlyscore.com/public/v3/customers/{customer_id}/affordability/personal' \ --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": [ { "year": 2021, "month": 11, "amount": 2000.0, "currency": "GBP", "affordability_type": "TWELVE_MONTH", "account_type": "personal" } ] }

Was this article helpful?

Friendly Score UK Ltd.

52 Brook Street 1st Floor, Mayfair

London W1K 5DS

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: 781963)