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

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
year	integer	yes	Year
month	integer	yes	Month
amount	float	yes	Monthly affordability amount
currency	string	yes	Currency
affordability_type	string	yes	Time window used for calculations. By default it is a 12 months window (type: TWELVE_MONTH).
account_type	string	yes	Bank 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

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

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)