policy

Get details of a pension fund policy

Changed on Apr 17, 2025

Provides details about the insurance policy including current retirement capital, prospective pension benefits for different retirement ages, contributions to financing the insurance etc.

get/policies/{policyId}

Request

Base URL
https://pension.common-api.ch
URL
https://pension.common-api.ch/policies/{policyId}
Auth
OAuth 2
Authorization code: https://example.com/oauth/authorize
Token URL: https://example.com/oauth/token scopes: read:basic_pension_data

Path parameters

policyIdstring required

Technical ID of policy used in API calls.

Example:Pol_56789-2024

Technical policy ID.

Response

Policy details.

contractNostring required

Contract number of contract between employer and pension fund.

entryDatestring date required

Entry date into the pension plan.

personIdstring required

Technical ID of insured person used in API calls.

policyIdstring required

Technical ID of policy used in API calls.

policyNostring required

Policy number (as printed on policy statements).

referenceDatestring date required

Reference date of the personal pension details.

isInVestedBenefitFoundationboolean

Indicates if policy is part of a vested benefit foundation (as opposed to a regular pension fund with payments from an employer). If the field is not set, a regular pension fund is assumed.

Example response

{
  "contractNo": "C27-842.183",
  "entryDate": "2018-04-13",
  "pensionPlan": {
    "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"
  },
  "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
  },
  "policyId": "Pol_56789-2024",
  "policyNo": "392'485'482",
  "referenceDate": "2018-04-13",
  "employer": {
    "employerName": "Acrea AG",
    "employerId": "CHE115873291",
    "industry": "information technology and management consulting"
  }
}

Changes

Apr 17, 20250c781dae9ac9 Revision changes
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property //// became optional for the status
- warning
  removed the optional property // from the response with the status
- info
  added the optional property // to the response with the status
- info
  the response property // became required for the status
- info
  the response property / became required for the status
Feb 7, 202587835f5abbb4 Revision changes
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  the response property // became required for the status
- info
  added the required property / to the response with the status

Operation history (3 revisions)