Get Personal Affordability Weights

GET

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

Returns Affordability Weights for personal bank accounts.

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
statusstringyesDetermines if weighted affordability is enabled. Possible values: enabled, disabled
dataAffordability Weights DatayesArray of data

Affordability Weights Data

ParameterData typeRequired?Description
idintyesId
valuestringyesValue
categorystringyesCategory name
income_expenditurestringyesDetermines 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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "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.

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