---
title: "Simulate effects of salary and employment level change"
method: POST
path: "/policies/{policyId}/salary-change-simulation"
tags: ["simulation"]
---

# Simulate effects of salary and employment level change

`POST /policies/{policyId}/salary-change-simulation`

Simulates the effects of a salary and/or employment level change on personal pension details (e.g. retirement capital).

## Path parameters

- `policyId` string, required — Technical ID of policy used in API calls.

## Request body

- SalaryChangeSimParameters — Salary change simulation parameters.
  - `declaredSalary` number, double, required — Changed gross annual salary in CHF (for employment level 100%).
  - `employmentLevel` number, double, required — Changed level of full-time/part-time employment (in percent, 100 for full-time employment).
  - `effectiveDate` string, date — Date when the salary change takes effect. If omitted: tomorrow.

## Response `200`

Simulation result.

- SimulationResultPensionStatement — Financial effect of simulation.
  - `pensionStatementAfterChange` PensionStatement, required — Pension statement consisting of the basic pension statement information, including aggregated personal pension data across related policies.
    - `employer` Employer, required — Details of the insured person's employer.
      - `employerName` string, required — The name of the employer.
      - `employerId` string — Swiss Enterprise Identification Number UID.
      - `industry` string — The industry or sector the employer operates in.
    - `pensionPlans` PensionPlan[], required — List of related pension plans.
      - `contractType` 'mand' | 'suppl' | 'earlyRet' | 'bridge' | '1e' | 'other', required — The contract type of the pension plan, represented by a string identifier. Allowed values are: - `mand`: Mandatory BVG contract. - `suppl`: Supplementary pension plan. - `earlyRet`: Plan for early retirement. - `bridge`: Bridge pension plan. - `1e`: 1e pension plan. - `other`: Other contract type not covered by the predefined categories.
      - `planName` string, required — Insurance plan name.
      - `optionalSavingsPlanName` string — Name of the optional savings plan.
      - `planId` string — Technical ID of pension plan used in API calls.
    - `pensionProvider` PensionProvider, required — Pension provider (foundation) administering the policy.
      - `providerName` string, required — The name of the pension provider.
      - `portalName` string — Offical name of the insurance portal.
      - `portalUrl` string — URL of the insurance portal of the pension fund.
      - `providerAddress` Address — Postal/residence address.
        - `countryCode` string, required — ISO country code.
        - `postalCode` string, required — Postal code.
        - `street` string, required — Street and house number.
        - `town` string, required — Town.
        - `poBox` string — PO box.
      - `providerId` string — Swiss Enterprise Identification Number UID.
    - `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
    - `personId` string, required — Technical ID of insured person used in API calls.
    - `personalPensionDetails` PersonalPensionDetails, required — Shared pension-related data specific to the insured person. This data structure is used in policies and pension statements to represent key attributes like salary, capital and benefits.
      - `earliestRetirementAge` integer, required — Age (in month since birth) for earliest possible retirement.
      - `financing` Financing, required — Contributions for financing the policy.
        - `contributionSavingsEmployer` number, double, required — Annual contribution towards the retirement captial financed by the employer.
        - `contributionSavingsInsuredPerson` number, double, required — Annual contribution towards the retirement captial financed by the insured person.
        - `contributionAdministrationEmployer` number, double — Annual contribution towards fund administration financed by the employer.
        - `contributionAdministrationInsuredPerson` number, double — Annual contribution towards fund administration financed by the insured person.
        - `contributionRiskEmployer` number, double — Annual contribution towards risk benefits financed by the employer.
        - `contributionRiskInsuredPerson` number, double — Annual contribution towards risk benefits financed by the insured person.
      - `homeOwnershipAvailableForWithdrawal` number, double, required — The total amount available for the insured person to withdraw from their retirement capital for the purpose of financing home ownership. After age 50, this amount is subject to legal limitations, which are already reflected in the stated value.
      - `ordinaryRetirementAge` integer, required — Age (in month since birth) for ordinary retirement.
      - `regularPurchaseMaxAmount` number, double, required — The maximum amount the insured person is permitted to contribute to their pension plan as an ordinary purchase, excluding any purchase to finance or compensate for early retirement.
      - `retirementCapital` RetirementCapital, required — Retirement capital balances for the past and projections for the future.
        - `balanceMandatoryReferenceDate` number, double, required — Retirement capital under mandatory coverage as per a specified reference date.
        - `balanceReferenceDate` number, double, required — Retirement capital as per a specified reference date (mandatory and supplementary coverage).
        - `interestRates` InterestRates, required — A set of interest rates applicable/applied to the retirement capital, including actual rates for mandatory and supplementary coverage. Rates for saving/purchase and projection rates for future value calculations.
          - `interestRateEnvelopingProjection` number, double — Common interest rate object.
          - `interestRateEnvelopingPurchase` number, double — Common interest rate object.
          - `interestRateEnvelopingSaving` number, double — Common interest rate object.
          - `interestRateMandatoryProjection` number, double — Common interest rate object.
          - `interestRateMandatoryPurchase` number, double — Common interest rate object.
          - `interestRateMandatorySaving` number, double — Common interest rate object.
          - `interestRateSupplementaryProjection` number, double — Common interest rate object.
          - `interestRateSupplementaryPurchase` number, double — Common interest rate object.
          - `interestRateSupplementarySaving` number, double — Common interest rate object.
        - `lastYearDevelopment` LastYearDevelopment, required — Details about the capital development for the last year. In most cases, all fields should be populated with actual values reflecting the previous calendar year. However, if the insured person joined during the current year, some or all of the fields may be missing due to the absence of a full year of history. Consumers of this data should account for potentially missing values in such cases.
          - `balanceBeginningLastYear` number, double — The capital balance at the beginning of the last year.
          - `balanceEndLastYear` number, double — The capital balance at the end of the last year.
          - `interestCreditLastYear` number, double — Interest credits added during the last year.
          - `interestRatesLastYear` InterestRates — A set of interest rates applicable/applied to the retirement capital, including actual rates for mandatory and supplementary coverage. Rates for saving/purchase and projection rates for future value calculations.
            - `interestRateEnvelopingProjection` number, double — Common interest rate object.
            - `interestRateEnvelopingPurchase` number, double — Common interest rate object.
            - `interestRateEnvelopingSaving` number, double — Common interest rate object.
            - `interestRateMandatoryProjection` number, double — Common interest rate object.
            - `interestRateMandatoryPurchase` number, double — Common interest rate object.
            - `interestRateMandatorySaving` number, double — Common interest rate object.
            - `interestRateSupplementaryProjection` number, double — Common interest rate object.
            - `interestRateSupplementaryPurchase` number, double — Common interest rate object.
            - `interestRateSupplementarySaving` number, double — Common interest rate object.
          - `oldAgeCreditLastYear` number, double — Old age credits added during the last year.
          - `totalDepositsLastYear` number, double — Total deposits made during the last year.
          - `totalWithdrawalsLastYear` number, double — Total withdrawals made during the last year.
        - `projectedRetirementBenefits` RetirementBenefits[], required — Projected retirement benefits for a series of retirement ages. The list contains projections for each integer retirement age from 58 to the regular retirement age. For persons of 58 or older, the list is restricted to retirement ages higher than their current age.
          - `capitalBalance` number, double, required — Retirement capital balance with interest (mandatory and supplementary coverage).
          - `capitalBalanceMandatory` number, double, required — Retirement capital balance with interest (mandatory coverage only).
          - `retirementAge` integer, required — Specified age (in month since birth) used for the retirement benefits calculation.
          - `capitalBalanceNoInterest` number, double — Retirement capital balance assuming no interest on assets (mandatory and supplementary coverage).
          - `capitalBalanceNoInterestMandatory` number, double — Retirement capital balance assuming no interest on assets (mandatory coverage only).
          - `conversionRateEnveloping` number, double — Enveloping conversion rate (capital to pension) for combined mandatory and supplementary coverage.
          - `conversionRateMandatory` number, double — Conversion rate (capital to pension) for mandatory coverage.
          - `conversionRateSupplementary` number, double — Conversion rate (capital to pension) for supplementary coverage.
          - `pension` number, double — Annual pension credit.
        - `balanceEndCurrentYear` number, double — Projected retirement capital as per end of the current year (mandatory and supplementary coverage).
        - `balanceMandatoryEndCurrentYear` number, double — Projected retirement capital under mandatory coverage as per end of the current year.
        - `transferredCapital` number, double — Total retirement capital (mandatory and supplementary coverage) brought from other funds into this fund.
        - `transferredCapitalMandatory` number, double — Retirement capital under mandatory coverage brought from other funds into this fund.
      - `riskBenefits` RiskBenefits, required — Benefits in case of death or disability to work.
        - `childPensionDisability` number, double, required — Annual child pension in case of disability.
        - `lumpSumWithoutPensionBenefits` number, double, required — A one-off lump sum payment in the event of death, provided no other recurring survivor benefits are paid. This applies when there is no entitlement to a partner's pension, orphan's pension, or any other ongoing survivor benefits. The amount typically corresponds to the insured person's accrued retirement savings as defined by the pension plan.
        - `minimalLumpSumWithPensionBenefits` number, double, required — A guaranteed minimum one-off lump sum payment in the event of death, which is paid in addition to other pension benefits (e.g., a partner’s pension, orphan’s pension, or other recurring survivor benefits). This amount can include: - Voluntary additional contributions (Einkäufe) made by the insured person. - Other supplementary pension capital as defined by the pension plan regulations. For example, in some cases, the full accrued retirement savings may be paid in addition to ongoing pension benefits. The exact composition and amount of this lump sum depend on the pension plan's rules and the insured person's specific situation.
        - `orphanPensionDeath` number, double, required — Annual orphan pension in case of death.
        - `partnerPensionDeath` number, double, required — Annual partner pension in case of death.
        - `pensionDisability` number, double, required — Annual pension in case of disability.
      - `salaryData` SalaryData, required — Details of salary relevant for insurance.
        - `declaredSalary` number, double, required — Gross annual salary.
        - `employmentLevel` number, double, required — Level of full-time/part-time employment (in percent, 100 for full-time employment).
        - `insuredSalaryMandatory` number, double, required — Annual salary insured under mandatory coverage.
        - `insuredSalaryRetirement` number, double, required — Annual salary insured for retirement benefits (mandatory and supplementary coverage).
        - `insuredSalaryRisk` number, double, required — Annual salary insured for risk benefits (mandatory and supplementary coverage).
        - `additionalSalary` number, double — Additional salary component.
        - `bonus` number, double — Bonus component of the salary.
        - `otherSalaryComponent` number, double — Other salary component.
      - `vestedBenefits` VestedBenefits, required — The VestedBenefits object provides detailed information about the insured person's accrued retirement capital under occupational pension plans (2nd pillar). It includes key data such as retirement capital at significant milestones (e.g., age 50, marriage), and records of transactions like voluntary purchases, withdrawals for home ownership (WEF), or adjustments due to divorce. This information is essential for managing entitlements and processing pension transfers.
        - `capitalAt50` number, double — The insured person's retirement capital when he/she was 50 (mandatory and supplementary). Empty for persons younger than 50.
        - `capitalAt50Mandatory` number, double — The insured person's retirement capital when he/she was 50 (mandatory part only). Empty for persons younger than 50.
        - `capitalAtMarriage` number, double — The insured person's retirement capital before he/she got married or entered a registered partnership (mandatory and supplementary). Relevant is the last marriage or registered partnership (the marriage/partnership date is part of the insured person object.) Empty for persons who are not married or in a registered partnership.
        - `capitalAtMarriageMandatory` number, double — The insured person's retirement capital before he/she got married or entered a registered partnership (mandatory part only). Relevant is the last marriage or registered partnership (the marriage/partnership date is part of the insured person object.) Empty for persons who are not married or in a registered partnership.
        - `capitalFirstCommunicated` number, double — Vested benefit capital that has been initially communicated or had become due after January 1, 1995 (for insured persons having married before January 1, 1995).
        - `capitalFirstCommunicatedDate` string, date — Date when vested benefit capital has been initially communicated or had become due after January 1, 1995 (for insured persons having married before January 1, 1995).
        - `divorceWithdrawals` CapitalTransaction[] — List of withdrawls and refunds due to divorce made in the past.
          - `amount` number, double, required — Total transaction amount for mandatory and supplementary part. The amount is positive for payments towards the capital, and negative for withdrawals.
          - `date` string, date, required — Date of transaction.
          - `amountMandatory` number, double — Transaction amount for mandatory part only. The amount is positive for payments towards the capital, and negative for withdrawals.
        - `homeOwnershipWithdrawals` CapitalTransaction[] — List of withdrawls and refunds for home ownership promotion made in the past.
          - `amount` number, double, required — Total transaction amount for mandatory and supplementary part. The amount is positive for payments towards the capital, and negative for withdrawals.
          - `date` string, date, required — Date of transaction.
          - `amountMandatory` number, double — Transaction amount for mandatory part only. The amount is positive for payments towards the capital, and negative for withdrawals.
        - `pledges` Pledge[] — List of pledges of parts of the retirement capital.
          - `amount` number, double — Amount of retirement capital used for pledging (mandatory and supplementary).
          - `amountMandatory` number, double — Amount of retirement capital used for pledging (mandatory part only).
          - `pledgee` string — The name of the pledgee.
          - `pledgeeAddress` Address — Postal/residence address.
            - `countryCode` string, required — ISO country code.
            - `postalCode` string, required — Postal code.
            - `street` string, required — Street and house number.
            - `town` string, required — Town.
            - `poBox` string — PO box.
        - `referenceDate` string, date — Reference date of the vested benefit information.
        - `voluntaryPurchases` CapitalTransaction[] — List of voluntary purchases of additional pension benefits made in the past. At least the purchases of the last 3 years must be included. They can be aggregated by calendar year.
          - `amount` number, double, required — Total transaction amount for mandatory and supplementary part. The amount is positive for payments towards the capital, and negative for withdrawals.
          - `date` string, date, required — Date of transaction.
          - `amountMandatory` number, double — Transaction amount for mandatory part only. The amount is positive for payments towards the capital, and negative for withdrawals.
      - `homeOwnershipAvailableForPledge` number, double — The total amount available for the insured person to pledge as collateral from their retirement capital for the purpose of financing home ownership. After age 50, this amount is subject to legal limitations, which are already reflected in the stated value. Note: If a fixed amount is contractually defined, it is usually lower than this value.
    - `referenceDate` string, date, required — Reference date of pension statement.
    - `timeStamp` string, date-time, required — Date and time of generation of the PensionStatement.
    - `languageCode` string — 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.
    - `pensionStatementId` string — Technical ID of pension statement used in API calls.
    - `pensionStatementNo` string — Pension statement number (as printed on statement).
  - `pensionStatementBeforeChange` PensionStatement, required — Pension statement consisting of the basic pension statement information, including aggregated personal pension data across related policies.
    - `employer` Employer, required — Details of the insured person's employer.
      - `employerName` string, required — The name of the employer.
      - `employerId` string — Swiss Enterprise Identification Number UID.
      - `industry` string — The industry or sector the employer operates in.
    - `pensionPlans` PensionPlan[], required — List of related pension plans.
      - `contractType` 'mand' | 'suppl' | 'earlyRet' | 'bridge' | '1e' | 'other', required — The contract type of the pension plan, represented by a string identifier. Allowed values are: - `mand`: Mandatory BVG contract. - `suppl`: Supplementary pension plan. - `earlyRet`: Plan for early retirement. - `bridge`: Bridge pension plan. - `1e`: 1e pension plan. - `other`: Other contract type not covered by the predefined categories.
      - `planName` string, required — Insurance plan name.
      - `optionalSavingsPlanName` string — Name of the optional savings plan.
      - `planId` string — Technical ID of pension plan used in API calls.
    - `pensionProvider` PensionProvider, required — Pension provider (foundation) administering the policy.
      - `providerName` string, required — The name of the pension provider.
      - `portalName` string — Offical name of the insurance portal.
      - `portalUrl` string — URL of the insurance portal of the pension fund.
      - `providerAddress` Address — Postal/residence address.
        - `countryCode` string, required — ISO country code.
        - `postalCode` string, required — Postal code.
        - `street` string, required — Street and house number.
        - `town` string, required — Town.
        - `poBox` string — PO box.
      - `providerId` string — Swiss Enterprise Identification Number UID.
    - `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
    - `personId` string, required — Technical ID of insured person used in API calls.
    - `personalPensionDetails` PersonalPensionDetails, required — Shared pension-related data specific to the insured person. This data structure is used in policies and pension statements to represent key attributes like salary, capital and benefits.
      - `earliestRetirementAge` integer, required — Age (in month since birth) for earliest possible retirement.
      - `financing` Financing, required — Contributions for financing the policy.
        - `contributionSavingsEmployer` number, double, required — Annual contribution towards the retirement captial financed by the employer.
        - `contributionSavingsInsuredPerson` number, double, required — Annual contribution towards the retirement captial financed by the insured person.
        - `contributionAdministrationEmployer` number, double — Annual contribution towards fund administration financed by the employer.
        - `contributionAdministrationInsuredPerson` number, double — Annual contribution towards fund administration financed by the insured person.
        - `contributionRiskEmployer` number, double — Annual contribution towards risk benefits financed by the employer.
        - `contributionRiskInsuredPerson` number, double — Annual contribution towards risk benefits financed by the insured person.
      - `homeOwnershipAvailableForWithdrawal` number, double, required — The total amount available for the insured person to withdraw from their retirement capital for the purpose of financing home ownership. After age 50, this amount is subject to legal limitations, which are already reflected in the stated value.
      - `ordinaryRetirementAge` integer, required — Age (in month since birth) for ordinary retirement.
      - `regularPurchaseMaxAmount` number, double, required — The maximum amount the insured person is permitted to contribute to their pension plan as an ordinary purchase, excluding any purchase to finance or compensate for early retirement.
      - `retirementCapital` RetirementCapital, required — Retirement capital balances for the past and projections for the future.
        - `balanceMandatoryReferenceDate` number, double, required — Retirement capital under mandatory coverage as per a specified reference date.
        - `balanceReferenceDate` number, double, required — Retirement capital as per a specified reference date (mandatory and supplementary coverage).
        - `interestRates` InterestRates, required — A set of interest rates applicable/applied to the retirement capital, including actual rates for mandatory and supplementary coverage. Rates for saving/purchase and projection rates for future value calculations.
          - `interestRateEnvelopingProjection` number, double — Common interest rate object.
          - `interestRateEnvelopingPurchase` number, double — Common interest rate object.
          - `interestRateEnvelopingSaving` number, double — Common interest rate object.
          - `interestRateMandatoryProjection` number, double — Common interest rate object.
          - `interestRateMandatoryPurchase` number, double — Common interest rate object.
          - `interestRateMandatorySaving` number, double — Common interest rate object.
          - `interestRateSupplementaryProjection` number, double — Common interest rate object.
          - `interestRateSupplementaryPurchase` number, double — Common interest rate object.
          - `interestRateSupplementarySaving` number, double — Common interest rate object.
        - `lastYearDevelopment` LastYearDevelopment, required — Details about the capital development for the last year. In most cases, all fields should be populated with actual values reflecting the previous calendar year. However, if the insured person joined during the current year, some or all of the fields may be missing due to the absence of a full year of history. Consumers of this data should account for potentially missing values in such cases.
          - `balanceBeginningLastYear` number, double — The capital balance at the beginning of the last year.
          - `balanceEndLastYear` number, double — The capital balance at the end of the last year.
          - `interestCreditLastYear` number, double — Interest credits added during the last year.
          - `interestRatesLastYear` InterestRates — A set of interest rates applicable/applied to the retirement capital, including actual rates for mandatory and supplementary coverage. Rates for saving/purchase and projection rates for future value calculations.
            - `interestRateEnvelopingProjection` number, double — Common interest rate object.
            - `interestRateEnvelopingPurchase` number, double — Common interest rate object.
            - `interestRateEnvelopingSaving` number, double — Common interest rate object.
            - `interestRateMandatoryProjection` number, double — Common interest rate object.
            - `interestRateMandatoryPurchase` number, double — Common interest rate object.
            - `interestRateMandatorySaving` number, double — Common interest rate object.
            - `interestRateSupplementaryProjection` number, double — Common interest rate object.
            - `interestRateSupplementaryPurchase` number, double — Common interest rate object.
            - `interestRateSupplementarySaving` number, double — Common interest rate object.
          - `oldAgeCreditLastYear` number, double — Old age credits added during the last year.
          - `totalDepositsLastYear` number, double — Total deposits made during the last year.
          - `totalWithdrawalsLastYear` number, double — Total withdrawals made during the last year.
        - `projectedRetirementBenefits` RetirementBenefits[], required — Projected retirement benefits for a series of retirement ages. The list contains projections for each integer retirement age from 58 to the regular retirement age. For persons of 58 or older, the list is restricted to retirement ages higher than their current age.
          - `capitalBalance` number, double, required — Retirement capital balance with interest (mandatory and supplementary coverage).
          - `capitalBalanceMandatory` number, double, required — Retirement capital balance with interest (mandatory coverage only).
          - `retirementAge` integer, required — Specified age (in month since birth) used for the retirement benefits calculation.
          - `capitalBalanceNoInterest` number, double — Retirement capital balance assuming no interest on assets (mandatory and supplementary coverage).
          - `capitalBalanceNoInterestMandatory` number, double — Retirement capital balance assuming no interest on assets (mandatory coverage only).
          - `conversionRateEnveloping` number, double — Enveloping conversion rate (capital to pension) for combined mandatory and supplementary coverage.
          - `conversionRateMandatory` number, double — Conversion rate (capital to pension) for mandatory coverage.
          - `conversionRateSupplementary` number, double — Conversion rate (capital to pension) for supplementary coverage.
          - `pension` number, double — Annual pension credit.
        - `balanceEndCurrentYear` number, double — Projected retirement capital as per end of the current year (mandatory and supplementary coverage).
        - `balanceMandatoryEndCurrentYear` number, double — Projected retirement capital under mandatory coverage as per end of the current year.
        - `transferredCapital` number, double — Total retirement capital (mandatory and supplementary coverage) brought from other funds into this fund.
        - `transferredCapitalMandatory` number, double — Retirement capital under mandatory coverage brought from other funds into this fund.
      - `riskBenefits` RiskBenefits, required — Benefits in case of death or disability to work.
        - `childPensionDisability` number, double, required — Annual child pension in case of disability.
        - `lumpSumWithoutPensionBenefits` number, double, required — A one-off lump sum payment in the event of death, provided no other recurring survivor benefits are paid. This applies when there is no entitlement to a partner's pension, orphan's pension, or any other ongoing survivor benefits. The amount typically corresponds to the insured person's accrued retirement savings as defined by the pension plan.
        - `minimalLumpSumWithPensionBenefits` number, double, required — A guaranteed minimum one-off lump sum payment in the event of death, which is paid in addition to other pension benefits (e.g., a partner’s pension, orphan’s pension, or other recurring survivor benefits). This amount can include: - Voluntary additional contributions (Einkäufe) made by the insured person. - Other supplementary pension capital as defined by the pension plan regulations. For example, in some cases, the full accrued retirement savings may be paid in addition to ongoing pension benefits. The exact composition and amount of this lump sum depend on the pension plan's rules and the insured person's specific situation.
        - `orphanPensionDeath` number, double, required — Annual orphan pension in case of death.
        - `partnerPensionDeath` number, double, required — Annual partner pension in case of death.
        - `pensionDisability` number, double, required — Annual pension in case of disability.
      - `salaryData` SalaryData, required — Details of salary relevant for insurance.
        - `declaredSalary` number, double, required — Gross annual salary.
        - `employmentLevel` number, double, required — Level of full-time/part-time employment (in percent, 100 for full-time employment).
        - `insuredSalaryMandatory` number, double, required — Annual salary insured under mandatory coverage.
        - `insuredSalaryRetirement` number, double, required — Annual salary insured for retirement benefits (mandatory and supplementary coverage).
        - `insuredSalaryRisk` number, double, required — Annual salary insured for risk benefits (mandatory and supplementary coverage).
        - `additionalSalary` number, double — Additional salary component.
        - `bonus` number, double — Bonus component of the salary.
        - `otherSalaryComponent` number, double — Other salary component.
      - `vestedBenefits` VestedBenefits, required — The VestedBenefits object provides detailed information about the insured person's accrued retirement capital under occupational pension plans (2nd pillar). It includes key data such as retirement capital at significant milestones (e.g., age 50, marriage), and records of transactions like voluntary purchases, withdrawals for home ownership (WEF), or adjustments due to divorce. This information is essential for managing entitlements and processing pension transfers.
        - `capitalAt50` number, double — The insured person's retirement capital when he/she was 50 (mandatory and supplementary). Empty for persons younger than 50.
        - `capitalAt50Mandatory` number, double — The insured person's retirement capital when he/she was 50 (mandatory part only). Empty for persons younger than 50.
        - `capitalAtMarriage` number, double — The insured person's retirement capital before he/she got married or entered a registered partnership (mandatory and supplementary). Relevant is the last marriage or registered partnership (the marriage/partnership date is part of the insured person object.) Empty for persons who are not married or in a registered partnership.
        - `capitalAtMarriageMandatory` number, double — The insured person's retirement capital before he/she got married or entered a registered partnership (mandatory part only). Relevant is the last marriage or registered partnership (the marriage/partnership date is part of the insured person object.) Empty for persons who are not married or in a registered partnership.
        - `capitalFirstCommunicated` number, double — Vested benefit capital that has been initially communicated or had become due after January 1, 1995 (for insured persons having married before January 1, 1995).
        - `capitalFirstCommunicatedDate` string, date — Date when vested benefit capital has been initially communicated or had become due after January 1, 1995 (for insured persons having married before January 1, 1995).
        - `divorceWithdrawals` CapitalTransaction[] — List of withdrawls and refunds due to divorce made in the past.
          - `amount` number, double, required — Total transaction amount for mandatory and supplementary part. The amount is positive for payments towards the capital, and negative for withdrawals.
          - `date` string, date, required — Date of transaction.
          - `amountMandatory` number, double — Transaction amount for mandatory part only. The amount is positive for payments towards the capital, and negative for withdrawals.
        - `homeOwnershipWithdrawals` CapitalTransaction[] — List of withdrawls and refunds for home ownership promotion made in the past.
          - `amount` number, double, required — Total transaction amount for mandatory and supplementary part. The amount is positive for payments towards the capital, and negative for withdrawals.
          - `date` string, date, required — Date of transaction.
          - `amountMandatory` number, double — Transaction amount for mandatory part only. The amount is positive for payments towards the capital, and negative for withdrawals.
        - `pledges` Pledge[] — List of pledges of parts of the retirement capital.
          - `amount` number, double — Amount of retirement capital used for pledging (mandatory and supplementary).
          - `amountMandatory` number, double — Amount of retirement capital used for pledging (mandatory part only).
          - `pledgee` string — The name of the pledgee.
          - `pledgeeAddress` Address — Postal/residence address.
            - `countryCode` string, required — ISO country code.
            - `postalCode` string, required — Postal code.
            - `street` string, required — Street and house number.
            - `town` string, required — Town.
            - `poBox` string — PO box.
        - `referenceDate` string, date — Reference date of the vested benefit information.
        - `voluntaryPurchases` CapitalTransaction[] — List of voluntary purchases of additional pension benefits made in the past. At least the purchases of the last 3 years must be included. They can be aggregated by calendar year.
          - `amount` number, double, required — Total transaction amount for mandatory and supplementary part. The amount is positive for payments towards the capital, and negative for withdrawals.
          - `date` string, date, required — Date of transaction.
          - `amountMandatory` number, double — Transaction amount for mandatory part only. The amount is positive for payments towards the capital, and negative for withdrawals.
      - `homeOwnershipAvailableForPledge` number, double — The total amount available for the insured person to pledge as collateral from their retirement capital for the purpose of financing home ownership. After age 50, this amount is subject to legal limitations, which are already reflected in the stated value. Note: If a fixed amount is contractually defined, it is usually lower than this value.
    - `referenceDate` string, date, required — Reference date of pension statement.
    - `timeStamp` string, date-time, required — Date and time of generation of the PensionStatement.
    - `languageCode` string — 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.
    - `pensionStatementId` string — Technical ID of pension statement used in API calls.
    - `pensionStatementNo` string — Pension statement number (as printed on statement).

## Other responses

- `401` — Access token is missing or invalid.
- `404` — Invalid ID / no authorization to access data.
- `500` — Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.net/swissfintechinnovations/apis/pension-2.md) · [All operations](https://skmtc.net/swissfintechinnovations/apis/pension-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/swissfintechinnovations/pension-2/revisions/ce7234453575/schema)