Get pension

GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}

Bearer auth

This endpoint allows users to retrieve a clients pension from their household.

Path parameters

HouseholdGUID string(uuid) Required

The HouseholdGUID of the client.
PensionGUID string(uuid) Required

The PensionGUID you want to retrieve.

Query parameters

ExcludeFormattedValues string

If set to any value, formatted values will be excluded from the response.

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
  
  PensionGUID string(uuid)
  
  ClientGUID string(uuid)
  
  PensionDescription string
  
  PensionType integer
  
  DependantGUID string(uuid)
  
  DCSpecialType integer
  
  CurrentValue number(float)
  
  CrystallisedFundValue number(float)
  
  ValueDate string(date)
  
  EndBasis integer
  
  EndEventGUID string(uuid)
  
  EndAge integer
  
  EndDate string
  
  Frequency integer
  
  TaxBasis integer
  
  ATRGUID string(uuid)
  
  NRA integer
  
  LinkedIncomeGUID string(uuid)
  
  ProtectedAge integer
  
  ProtectedTFC integer
  
  ProtectedTFCADayValue number(float)
  
  ProtectedTFCADayFundPension number(float)
  
  SpousePension number(float)
  
  GuaranteePeriodYears integer
  
  GuaranteePeriodMonths integer
  
  DBRetirementBasis integer
  
  AdditionalCash number(float)
  
  DCRetirementBasis integer
  
  DBAccrualBasis integer
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  CrystallisedPreviously number(float)
  
  SumAssured number(float)
  
  LumpSumDeathBenefitBasis integer
  
  DeathMultiple number(float)
  
  PolicyNumber string
  
  ProviderCode string
  
  FutureRiskLevelChange integer
  
  FutureRiskATRGUID string(uuid)
  
  FutureRiskDateOfChangeBasis integer
  
  FutureRiskDateOfChangeEventGUID string(uuid)
  
  FutureRiskDateOfChangeAge integer
  
  FutureRiskDateOfChangeDate string
  
  FormattedValues object
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}/pensions/{PensionGUID}

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}' \
 --header "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,
    "ATRGUID": "A8D0CDDA-8DA7-4D56-9AF0-3B2A62691FC9",
    "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": "F7FBB6B1-2D90-485C-AE89-9F9FA0426F1E",
    "BackOfficeSync": 1,
    "CrystallisedPreviously": 1000.1,
    "SumAssured": 1500,
    "LumpSumDeathBenefitBasis": 4,
    "DeathMultiple": 1500,
    "PolicyNumber": 134300454,
    "ProviderCode": "8379dc94-3bcf-e011-87a9-b8ac6f1693a9",
    "FutureRiskLevelChange": 1,
    "FutureRiskATRGUID": "9F420FE2-217F-4CD7-8B1A-1998F596C6EE",
    "FutureRiskDateOfChangeBasis": 4,
    "FutureRiskDateOfChangeEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
    "FutureRiskDateOfChangeAge": 55,
    "FutureRiskDateOfChangeDate": "2069-05-04",
    "FormattedValues": {
      "ATRGUID": "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%",
      "LinkedIncomeGUID": "Salary",
      "DBRetirementBasis": "Full Pension",
      "DCRetirementBasis": "100% Annuity",
      "FutureRiskATRGUID": "Lowest",
      "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."
}