Get pension options

GET /api/v2/household/{HouseholdGUID}/pensions/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
      • PensionType object

        Additional properties are allowed.

        Hide PensionType attributes Show PensionType attributes object
        • 1 string

          Value is Defined Benefit Deferred.

        • 6 string

          Value is Defined Benefit Active.

        • 5 string

          Value is Defined Contribution Fund.

      • DCSpecialType object

        Additional properties are allowed.

        Hide DCSpecialType attributes Show DCSpecialType attributes object

        • Value is None (normal pension fund).

        • 1 string

          Value is Beneficiary Drawdown (death pre age 75).

        • 2 string

          Value is QROP scheme (30% tax free cash).

      • Frequency object

        Additional properties are allowed.

        Hide Frequency attributes Show Frequency attributes object
        • 120 string

          Value is One-off.

        • 52 string

          Value is Paid Weekly.

        • 26 string

          Value is Paid Fortnightly.

      • Providercode object

        Additional properties are allowed.

        Hide Providercode attributes Show Providercode attributes object
      • EndBasis object

        Additional properties are allowed.

        Hide EndBasis attributes Show EndBasis attributes object
        • 1 string

          Value is In Payment.

        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

      • EndEventGUID object

        Additional properties are allowed.

        Hide EndEventGUID attributes Show EndEventGUID attributes object
      • TaxBasis object

        Additional properties are allowed.

        Hide TaxBasis attributes Show TaxBasis attributes object
        • 1 string

          Value is Taxable.

        • 2 string

          Value is Non-Taxable.

      • ATRSlot object

        Additional properties are allowed.

        Hide ATRSlot attributes Show ATRSlot attributes object
        • 17 string

          Value is Lowest.

        • 19 string

          Value is Cautious.

        • 22 string

          Value is Balanced and more.

      • DBAccrualBasis object

        Additional properties are allowed.

        Hide DBAccrualBasis attributes Show DBAccrualBasis attributes object
        • 1 string

          Value is Final Salary.

        • 2 string

          Value is Career Average.

      • LumpSumDeathBenefitBasis object

        Additional properties are allowed.

        Hide LumpSumDeathBenefitBasis attributes Show LumpSumDeathBenefitBasis attributes object
        • 1 string

          Value is None.

        • 2 string

          Value is £.

        • 3 string

          Value is Multiple of pension.

      • ProtectedAge object

        Additional properties are allowed.

        Hide ProtectedAge attributes Show ProtectedAge attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • ProtectedTFC object

        Additional properties are allowed.

        Hide ProtectedTFC attributes Show ProtectedTFC attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • DBRetirementBasis object

        Additional properties are allowed.

        Hide DBRetirementBasis attributes Show DBRetirementBasis attributes object
        • 1 string

          Value is Full Pension.

        • 2 string

          Value is Max Tax Free Cash and Reduced Pension.

        • 3 string

          Value is Max PCLS and Reduced Pension.

      • DCRetirementBasis object

        Additional properties are allowed.

        Hide DCRetirementBasis attributes Show DCRetirementBasis attributes object
        • 1 string

          Value is 100% Annuity.

        • 2 string

          Value is Max Tax Free Cash + Annuity.

        • 3 string

          Value is Auto Withdrawals.

        • 4 string

          Value is Never touch.

        • 5 string

          Value is Auto Withdrawals from retirement age.

      • LinkedIncomeGUID object

        Additional properties are allowed.

        Hide LinkedIncomeGUID attributes Show LinkedIncomeGUID attributes object
      • 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.

      • 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.

        • 19 string

          Value is Cautious.

        • 22 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}/pensions/options 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/options \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "PensionType": {
      "1": "Defined Benefit Deferred",
      "6": "Defined Benefit Active",
      "5": "Defined Contribution Fund"
    },
    "DCSpecialType": {
      "": "None (normal pension fund)",
      "1": "Beneficiary Drawdown (death pre age 75)",
      "2": "QROP scheme (30% tax free cash)"
    },
    "Frequency": {
      "120": "One-off",
      "52": "Paid Weekly",
      "26": "Paid Fortnightly"
    },
    "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"
    },
    "EndBasis": {
      "1": "In Payment",
      "2": "Specific Age",
      "3": "Specific Date"
    },
    "EndEventGUID": {
      "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"
    },
    "TaxBasis": {
      "1": "Taxable",
      "2": "Non-Taxable"
    },
    "ATRSlot": {
      "17": "Lowest",
      "19": "Cautious",
      "22": "Balanced and more"
    },
    "DBAccrualBasis": {
      "1": "Final Salary",
      "2": "Career Average"
    },
    "LumpSumDeathBenefitBasis": {
      "1": "None",
      "2": "£",
      "3": "Multiple of pension"
    },
    "ProtectedAge": {
      "1": "Yes",
      "2": "No"
    },
    "ProtectedTFC": {
      "1": "Yes",
      "2": "No"
    },
    "DBRetirementBasis": {
      "1": "Full Pension",
      "2": "Max Tax Free Cash and Reduced Pension",
      "3": "Max PCLS and Reduced Pension"
    },
    "DCRetirementBasis": {
      "1": "100% Annuity",
      "2": "Max Tax Free Cash + Annuity",
      "3": "Auto Withdrawals",
      "4": "Never touch",
      "5": "Auto Withdrawals from retirement age"
    },
    "LinkedIncomeGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Our House",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Our Boat",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Rental Property"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    },
    "FutureRiskLevelChange": {
      "1": "Yes",
      "2": "No"
    },
    "FutureRiskLevel": {
      "17": "Lowest",
      "19": "Cautious",
      "22": "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."
}