Sign in

v24

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

Get the compact pension statement for the specified id

Provides the pension statement for the specified id as a compact json in the insured person's preferred language. Its sole purpose is to provide a compact json for use cases with tight data volume limits such as e.g. a QR code. This endpoint should not be used otherwise.

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

get/statements/{pensionStatementId}/compact-statements

Path parameters

pensionStatementIdstring required

Technical ID of pension statement used in API calls.

Example:550e8450-e59b-21d4-a346-442215440560

Technical pension statement ID.

Response

Compact statement details.

bymstring required

Year and month of birth (Format YYYY-MM).

eiistring required

Pension system internal identifier of the employer that must not be publicly known. Distinct from the Swiss Enterprise Identification Number UID.

enstring required

The name of the employer.

erainteger required

Age (in month since birth) for earliest possible retirement.

hoawnumber 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.

orainteger required

Age (in month since birth) for ordinary retirement.

ppistring required

Swiss Enterprise Identification Number UID.

ppnstring required

The name of the pension provider.

pst'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
rdstring date required

Reference date of pension statement.

rpmnumber 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.

tsstring date-time required

Date and time of generation of the PensionStatement.

Example response

{
  "bym": "1985-05",
  "eii": "EMP_4711",
  "en": "Acrea AG",
  "era": 696,
  "hoaw": 31000,
  "ora": 780,
  "ppi": "CHE123456789",
  "ppl": {
    "ct": "mand",
    "pln": "Basisplan"
  },
  "ppn": "Omnifund",
  "pst": "regular",
  "rb": {
    "cpd": 5382,
    "mlswpb": 74383,
    "opd": 5382,
    "pd": 40213,
    "ppd": 24817
  },
  "rc": {
    "bmr": 38942.15,
    "brd": 53842.5,
    "prb": [
      {
        "cb": 378832.05,
        "p": 22835,
        "ra": 756
      }
    ]
  },
  "rd": "2018-04-13",
  "rpm": 48392.45,
  "sd": {
    "ds": 78000,
    "el": 100,
    "ism": 59215,
    "isre": 59215,
    "isri": 59215
  },
  "ts": "2018-04-13T11:11:11Z"
}