Get savings options

GET /api/v2/household/{HouseholdGUID}/savings/options
Bearer auth

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

  • HouseholdGUID string(uuid) Required

    The GUID of the household you wish to get options for.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • success boolean

      Default value is true.

    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • SavingsType object

        Additional properties are allowed.

        Hide SavingsType attributes Show SavingsType attributes object
        • 1 string

          Value is Bank Current Account.

        • 6 string

          Value is Bank Savings Account.

        • 5 string

          Value is Cash ISA.

      • Providercode object

        Additional properties are allowed.

        Hide Providercode attributes Show Providercode attributes object
      • ATRSlot object

        Additional properties are allowed.

        Hide ATRSlot attributes Show ATRSlot attributes object
        • 17 string

          Value is Lowest.

        • 22 string

          Value is Cautious.

        • 19 string

          Value is Balanced and more.

      • BackOfficeSync object

        Additional properties are allowed.

        Hide BackOfficeSync attributes Show BackOfficeSync attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

        • 3 string

          Value is Only update from back office.

      • DefaultAccount object

        Additional properties are allowed.

        Hide DefaultAccount attributes Show DefaultAccount attributes object

        • Value is No.

        • 1 string

          Value is Yes.

      • ISASpecialType object

        Additional properties are allowed.

        Hide ISASpecialType attributes Show ISASpecialType attributes object
        • 1 string

          Value is Junior ISA.

        • 2 string

          Value is Lifetime ISA.

      • FutureRiskLevelChange object

        Additional properties are allowed.

        Hide FutureRiskLevelChange attributes Show FutureRiskLevelChange attributes object
        • 1 integer

          Value is Yes.

        • 2 integer

          Value is No.

      • FutureRiskLevel object

        Additional properties are allowed.

        Hide FutureRiskLevel attributes Show FutureRiskLevel attributes object
        • 17 string

          Value is Lowest.

        • 22 string

          Value is Cautious.

        • 19 string

          Value is Balanced and more.

      • FutureRiskDateOfChangeBasis object

        Additional properties are allowed.

        Hide FutureRiskDateOfChangeBasis attributes Show FutureRiskDateOfChangeBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • FutureRiskDateOfChangeEventGUID object

        Additional properties are allowed.

        Hide FutureRiskDateOfChangeEventGUID attributes Show FutureRiskDateOfChangeEventGUID attributes object
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
  • 404 application/json

    Household not found

    Hide response attributes Show response attributes object
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."
}