Get savings options
This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.
Path parameters
-
The GUID of the household you wish to get options for.
GET /api/v2/household/{HouseholdGUID}/savings/options
curl \
-X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/savings/options \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"success": true,
"data": {
"SavingsType": {
"1": "Bank Current Account",
"6": "Bank Savings Account",
"5": "Cash ISA"
},
"Providercode": {
"00028d6f-3ccf-e011-87a9-b8ac6f1693a8": "Life Assurance Corporation of India",
"001ee90c-3dcf-e011-87a9-b8ac6f1693a8": "Toluna Plc",
"002c2f7c-3bcf-e011-87a9-b8ac6f1693a8": "Standard Life Investments"
},
"ATRSlot": {
"17": "Lowest",
"22": "Cautious",
"19": "Balanced and more"
},
"BackOfficeSync": {
"1": "Yes",
"2": "No",
"3": "Only update from back office"
},
"DefaultAccount": {
"": "No",
"1": "Yes"
},
"ISASpecialType": {
"1": "Junior ISA",
"2": "Lifetime ISA"
},
"FutureRiskLevelChange": {
"1": "Yes",
"2": "No"
},
"FutureRiskLevel": {
"17": "Lowest",
"22": "Cautious",
"19": "Balanced and more"
},
"FutureRiskDateOfChangeBasis": {
"2": "Specific Age",
"3": "Specific Date",
"4": "Event"
},
"FutureRiskDateOfChangeEventGUID": {
"8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
"1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
"E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
}
}
}
Response examples (403)
{
"success": false,
"message": "You do not have permission to view the household."
}
Response examples (404)
{
"success": false,
"message": "Household not found."
}