v24

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-06-25129690.0 KB

statement

Get pension statement(s) data

Provides the pension statement(s) representing the state of the policy/policies for the specified date as structured data. If no date is specified, the latest (regular/official) pension statement(s) associated with the insured person is retrieved. If a person has several policies (associated to different pension plans), either an aggregated statement is delivered or one statement per pension plan. This can vary depending on the pension fund. In the aggregated statement, the related pension plans are listed.

If the pension fund is unable to provide a statement for the request date, the error code 400 should be returned.

get/insured-persons/{personId}/statements

Path parameters

personIdstring required

Technical ID of insured person used in API calls.

Example:JohnDoe_1234

Technical person ID.

Query parameters

reference_datestring date

Common date format.

Example:2018-04-13

Reference date for information in output.

Response

Statement details.

pensionStatementType'regular' | 'simulated' required

Pension statement type:

regular: the pension statement is an offical, regular statement on the basis of real values (not changed for simulation purposes)
simulated: the pension statement is a non-offical, simulated statement, i.e. some values might have been changed for simulation purposes

personIdstring required

Technical ID of insured person used in API calls.

referenceDatestring date required

Reference date of pension statement.

timeStampstring date-time required

Date and time of generation of the PensionStatement.

languageCodestring

Language code according to ISO 639-1. Examples: de (German), fr (French), it (Italian), en (English). Used to indicate the language of content based on the insured person's profile.

pensionStatementIdstring

Technical ID of pension statement used in API calls.

pensionStatementNostring

Pension statement number (as printed on statement).

Example response

[
  {
    "employer": {
      "employerName": "Acrea AG",
      "employerId": "CHE115873291",
      "industry": "information technology and management consulting"
    },
    "pensionPlans": [
      {
        "contractType": "mand",
        "planName": "Basisplan",
        "optionalSavingsPlanName": "Sparplan 2",
        "planId": "Plan_XY4284_425"
      }
    ],
    "pensionProvider": {
      "providerName": "Omnifund",
      "portalName": "Omni Portal",
      "portalUrl": "www.omnifund.ch",
      "providerAddress": {
        "countryCode": "CH",
        "postalCode": "3944",
        "street": "Brandstrasse 2",
        "town": "Unterbäch",
        "poBox": "PO Box 42"
      },
      "providerId": "CHE123456789"
    },
    "pensionStatementType": "regular",
    "personId": "JohnDoe_1234",
    "personalPensionDetails": {
      "earliestRetirementAge": 696,
      "financing": {
        "contributionSavingsEmployer": 4025,
        "contributionSavingsInsuredPerson": 4025
      },
      "homeOwnershipAvailableForWithdrawal": 31000,
      "ordinaryRetirementAge": 780,
      "regularPurchaseMaxAmount": 48392.45,
      "retirementCapital": {
        "balanceMandatoryReferenceDate": 38942.15,
        "balanceReferenceDate": 53842.5,
        "interestRates": {
          "interestRateEnvelopingProjection": 3.175,
          "interestRateEnvelopingPurchase": 3.175,
          "interestRateEnvelopingSaving": 3.175,
          "interestRateMandatoryProjection": 3.175,
          "interestRateMandatoryPurchase": 3.175,
          "interestRateMandatorySaving": 3.175,
          "interestRateSupplementaryProjection": 3.175,
          "interestRateSupplementaryPurchase": 3.175,
          "interestRateSupplementarySaving": 3.175
        },
        "lastYearDevelopment": {
          "balanceBeginningLastYear": 100000,
          "balanceEndLastYear": 106000,
          "interestCreditLastYear": 2000,
          "interestRatesLastYear": {
            "interestRateEnvelopingProjection": 3.175,
            "interestRateEnvelopingPurchase": 3.175,
            "interestRateEnvelopingSaving": 3.175,
            "interestRateMandatoryProjection": 3.175,
            "interestRateMandatoryPurchase": 3.175,
            "interestRateMandatorySaving": 3.175,
            "interestRateSupplementaryProjection": 3.175,
            "interestRateSupplementaryPurchase": 3.175,
            "interestRateSupplementarySaving": 3.175
          },
          "oldAgeCreditLastYear": 4000,
          "totalDepositsLastYear": 5000,
          "totalWithdrawalsLastYear": 5000
        },
        "projectedRetirementBenefits": [
          {
            "capitalBalance": 378832.05,
            "capitalBalanceMandatory": 284832.15,
            "retirementAge": 756,
            "capitalBalanceNoInterest": 331285.25,
            "capitalBalanceNoInterestMandatory": 248862.65,
            "conversionRateEnveloping": 6.3,
            "conversionRateMandatory": 6.8,
            "conversionRateSupplementary": 5.5,
            "pension": 22835
          }
        ],
        "balanceEndCurrentYear": 56325.25,
        "balanceMandatoryEndCurrentYear": 40846.6,
        "transferredCapital": 45210.25,
        "transferredCapitalMandatory": 32840.55
      },
      "riskBenefits": {
        "childPensionDisability": 5382,
        "lumpSumWithoutPensionBenefits": 92834,
        "minimalLumpSumWithPensionBenefits": 74383,
        "orphanPensionDeath": 5382,
        "partnerPensionDeath": 24817,
        "pensionDisability": 40213
      },
      "salaryData": {
        "declaredSalary": 78000,
        "employmentLevel": 100,
        "insuredSalaryMandatory": 59215,
        "insuredSalaryRetirement": 59215,
        "insuredSalaryRisk": 59215
      },
      "vestedBenefits": {
        "capitalAtMarriage": 28483.35,
        "capitalAtMarriageMandatory": 23863.15,
        "capitalFirstCommunicatedDate": "2018-04-13",
        "divorceWithdrawals": [
          {
            "date": "2018-04-13"
          }
        ],
        "homeOwnershipWithdrawals": [
          {
            "date": "2018-04-13"
          }
        ],
        "pledges": [
          {
            "amount": 20000,
            "amountMandatory": 20000,
            "pledgee": "UBS AG",
            "pledgeeAddress": {
              "countryCode": "CH",
              "postalCode": "3944",
              "street": "Brandstrasse 2",
              "town": "Unterbäch",
              "poBox": "PO Box 42"
            }
          }
        ],
        "referenceDate": "2018-04-13",
        "voluntaryPurchases": [
          {
            "date": "2018-04-13"
          }
        ]
      },
      "homeOwnershipAvailableForPledge": 50000
    },
    "referenceDate": "2018-04-13",
    "timeStamp": "2018-04-13T11:11:11Z",
    "languageCode": "de",
    "pensionStatementId": "550e8450-e59b-21d4-a346-442215440560",
    "pensionStatementNo": "PS_ID_6789-ABC"
  }
]