Sign in

v24

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

Get the compact 3a statement for the specified id

Provides the 3a 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-3a-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 3a statement details.

aistring required

Unique Account Identifier. Use IBAN format (ISO 13616) whenever possible. If the product does not have an IBAN, use the policy or contract number.

pnstring required

Product name.

ppnstring required

The name of the pension provider.

rdstring date required

Reference date of 3a account statement.

tsstring date-time required

Date and time of generation of the 3a account statement.

bchboolean

Indicates whether a beneficiary change occurred. true = there was a beneficiary change. false = there was no beneficiary change. Presence of this field confirms the status is known; omission indicates the status is unknown.

divnumber double

The amount withdrawn for pension equalization following a divorce. Presence of this field confirms that the status and amount are known. Set to 0 if no withdrawal occurred. Omission indicates that the status or amount is unknown.

plgnumber double

The amount of currently pledged capital. Presence of this field confirms that the status and amount are known. Set to 0 if no pledged capital exists. Omission indicates that the status or amount is unknown.

pwboolean

Indicates whether a premium waiver in case of disability applies. true = a premium waiver applies. false = no premium waiver applies. Presence of this field confirms the status is known. Omission indicates the status is unknown.

wefnumber double

The cumulative net amount withdrawn for home ownership financing (WEF). Based solely on information available to this provider, might be incomplete for technical reasons. Set to 0 if no withdrawal occurred. Omission indicates that the status or amount is unknown.

Example response

{
  "ai": "CH9300762011623852957",
  "cp": {
    "cy": 2500,
    "ret": 8400
  },
  "pn": "sparen 3a",
  "ppn": "Omnifund",
  "pyd": {
    "cg": 1000,
    "de": 5000,
    "fe": -100,
    "ic": 2000,
    "wi": -1000
  },
  "rc": {
    "cb": 378832.05,
    "cbpy": 378832.05,
    "inv": 85520
  },
  "rd": "2018-04-13",
  "ts": "2018-04-13T11:11:11Z",
  "bch": true,
  "cyd": {
    "cg": 1000,
    "de": 5000,
    "fe": -100,
    "ic": 2000,
    "wi": -1000
  },
  "div": 10000,
  "plg": 20000,
  "pw": true,
  "wef": 50000
}