Get pensions

GET /api/v2/household/{HouseholdGUID}/pensions
Bearer auth

This endpoint retrieves a list of all pensions belonging to the household. The response data will be an array of objects with each object being the data for one pension.

Path parameters

  • HouseholdGUID string(uuid) Required

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

Responses

GET /api/v2/household/{HouseholdGUID}/pensions 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": [
    {
      "PensionGUID": "E3AEEF8D-3A6F-44B5-BA6D-8E8C7646C9D6",
      "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "PensionDescription": "DB Fund",
      "PensionType": 1,
      "DependantGUID": "4FDA7A23-46AF-45B0-89DB-635544D65147",
      "DCSpecialType": 2,
      "CurrentValue": 1000.1,
      "CrystallisedFundValue": 1000.1,
      "ValueDate": "2023-04-25",
      "EndBasis": 4,
      "EndEventGUID": "A3290089-8FF3-3729-21E2-492423599F57",
      "EndAge": 70,
      "EndDate": "2069-02-01",
      "Frequency": 1,
      "TaxBasis": 1,
      "ATRSlot": 22,
      "NRA": 75,
      "LinkedIncomeGUID": "D3290089-8FF3-3729-21E2-492423599F54",
      "ProtectedAge": 2,
      "ProtectedTFC": 2,
      "ProtectedTFCADayValue": 1000.1,
      "ProtectedTFCADayFundPension": 1000.1,
      "SpousePension": 12,
      "GuaranteePeriodYears": 12,
      "GuaranteePeriodMonths": 5,
      "DBRetirementBasis": 1,
      "AdditionalCash": 1000,
      "DCRetirementBasis": 1,
      "DBAccrualBasis": 1,
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "CrystallisedPreviously": 1000.1,
      "SumAssured": 1500,
      "LumpSumDeathBenefitBasis": 4,
      "DeathMultiple": 1500,
      "PolicyNumber": 134300454,
      "ProviderCode": "8379dc94-3bcf-e011-87a9-b8ac6f1693a9",
      "FutureRiskLevelChange": 1,
      "FutureRiskLevel": 17,
      "FutureRiskDateOfChangeBasis": 4,
      "FutureRiskDateOfChangeEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "FutureRiskDateOfChangeAge": 55,
      "FutureRiskDateOfChangeDate": "2069-05-04",
      "FormattedValues": {
        "ATRSlot": "Cautious",
        "EndDate": "01/02/2069",
        "EndBasis": "Event",
        "TaxBasis": "Taxable",
        "Frequency": "One-off",
        "ValueDate": "25/04/2023",
        "SumAssured": "£1,500",
        "PensionType": "Defined Benefit Deferred",
        "CurrentValue": "£1,000",
        "EndEventGUID": "API Tester",
        "ProtectedAge": "No",
        "ProtectedTFC": "No",
        "ProviderCode": "1st Policy Company Limited",
        "DCSpecialType": "QROP scheme (30% tax free cash)",
        "DeathMultiple": "x4",
        "DependantGUID": "Diane Edwards",
        "SpousePension": "12%",
        "FutureRiskLevel": "Lowest",
        "LinkedIncomeGUID": "Salary",
        "DBRetirementBasis": "Full Pension",
        "DCRetirementBasis": "100% Annuity",
        "CrystallisedFundValue": "£1,000",
        "FutureRiskLevelChange": "Yes",
        "ProtectedTFCADayValue": "£1,000",
        "CrystallisedPreviously": "£1,000",
        "LumpSumDeathBenefitBasis": "Multiple of pension",
        "FutureRiskDateOfChangeDate": "04/05/2069",
        "FutureRiskDateOfChangeBasis": "Event",
        "ProtectedTFCADayFundPension": "£1,000",
        "FutureRiskDateOfChangeEventGUID": "API's State Pension Age"
      }
    }
  ]
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}