Get Personal Affordability Weights

GET

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

Returns Affordability Weights for personal bank 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
status	string	yes	Determines if weighted affordability is enabled. Possible values: enabled, disabled
data	Affordability Weights Data	yes	Array of data

Affordability Weights Data

Parameter	Data type	Required?	Description
id	int	yes	Id
value	string	yes	Value
category	string	yes	Category name
income_expenditure	string	yes	Determines if category is income or expenditures

Request example

1
2
3

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

Response example:

{
    "data": [
        {
            "id": 1,
            "value": 100,
            "category": "Benefits",
            "income_expenditure": "income"
        },
        {
            "id": 2,
            "value": 50,
            "category": "Cash Deposits",
            "income_expenditure": "income"
        }
    ],
    "status": "enabled"
}

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)