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
      Hide data attributes Show data attributes object
      • SavingsType object
        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
        Hide Providercode attributes Show Providercode attributes object
        • 00028d6f-3ccf-e011-87a9-b8ac6f1693a8 string

          Value is Life Assurance Corporation of India.

        • 001ee90c-3dcf-e011-87a9-b8ac6f1693a8 string

          Value is Toluna Plc.

        • 002c2f7c-3bcf-e011-87a9-b8ac6f1693a8 string

          Value is Standard Life Investments.

      • ATRGUID object
        Hide ATRGUID attributes Show ATRGUID attributes object
        • 33299931-7868-887F-3C19-78CA60CD0577 string

          Value is Lowest.

        • 2EEEF1E2-6EA9-7D33-0004-8F685E68EACB string

          Value is Cautious.

        • 09D8AC13-FEA5-3CB8-3457-DCF94F039AC8 string

          Value is Balanced and more.

      • BackOfficeSync object
        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
        Hide DefaultAccount attribute Show DefaultAccount attribute object
        • 1 string

          Value is Yes.

      • ISASpecialType object
        Hide ISASpecialType attributes Show ISASpecialType attributes object
        • 1 string

          Value is Junior ISA.

        • 2 string

          Value is Lifetime ISA.

      • FutureRiskLevelChange object
        Hide FutureRiskLevelChange attributes Show FutureRiskLevelChange attributes object
        • 1 integer

          Value is Yes.

        • 2 integer

          Value is No.

      • FutureRiskATRGUID object
        Hide FutureRiskATRGUID attributes Show FutureRiskATRGUID attributes object
        • A158778F-8177-4485-9219-47B9466983FE string

          Value is Lowest.

        • 18B75EE3-BB80-417D-BEC4-8974B9CC5A65 string

          Value is Cautious.

        • B25DB274-F8F8-4C2B-BF78-74736D15F25B string

          Value is Balanced and more.

      • FutureRiskDateOfChangeBasis object
        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
        Hide FutureRiskDateOfChangeEventGUID attributes Show FutureRiskDateOfChangeEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • NeverTouch object
        Hide NeverTouch attributes Show NeverTouch attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
  • 404 application/json

    Household not found

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
GET /api/v2/household/{HouseholdGUID}/savings/options 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/savings/options' \
 --header "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"
    },
    "ATRGUID": {
      "33299931-7868-887F-3C19-78CA60CD0577": "Lowest",
      "2EEEF1E2-6EA9-7D33-0004-8F685E68EACB": "Cautious",
      "09D8AC13-FEA5-3CB8-3457-DCF94F039AC8": "Balanced and more"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    },
    "DefaultAccount": {
      "1": "Yes"
    },
    "ISASpecialType": {
      "1": "Junior ISA",
      "2": "Lifetime ISA"
    },
    "FutureRiskLevelChange": {
      "1": "Yes",
      "2": "No"
    },
    "FutureRiskATRGUID": {
      "A158778F-8177-4485-9219-47B9466983FE": "Lowest",
      "18B75EE3-BB80-417D-BEC4-8974B9CC5A65": "Cautious",
      "B25DB274-F8F8-4C2B-BF78-74736D15F25B": "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"
    },
    "NeverTouch": {
      "1": "Yes",
      "2": "No"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}