--- title: "Get the compact vested benefits statement for the specified id" method: GET path: "/statements/{pensionStatementId}/compact-vb-statements" tags: ["statement"] --- # Get the compact vested benefits statement for the specified id `GET /statements/{pensionStatementId}/compact-vb-statements` Provides the vested benefits 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. ## Path parameters - `pensionStatementId` string, required — Technical ID of pension statement used in API calls. ## Response `200` Compact vested benefits statement details. - PscVb — PscVb = pension statement compact vested benefit, is a reduced pension statement consisting of only the most important pension statement information. All monetary values are in Swiss Francs (CHF) unless explicitly stated otherwise. Short property names (3-4 chars) for QR code payload. - `ai` string, 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. - `hoaw` 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. - `pn` string, required — Product name. - `ppn` string, required — The name of the pension provider. - `pyd` CapitalDevelopment, required — Shared capital development fields. - `cg` number, double — Total capital gains (positive) or losses (negative) from investments for the period. - `de` number, double — Total deposits or inflows for the period. - `fe` number, double — Total management or administrative fees for the period. Debits must be provided as a negative value. - `ic` number, double — Total interest credits for the period. - `wi` number, double — Total withdrawals or outflows for the period, e.g. for home ownership (WEF) or divorce settlements. Debits must be provided as a negative value. - `rc` object, required — Retirement capital balances. Consistency rules: - cb = cbpy + sum of cyd-properties Minor rounding differences up to CHF 0.05 are acceptable. - `cb` number, double, required — Retirement capital balance with interest (mandatory and supplementary coverage). - `cbpy` number, double, required — Retirement capital balance with interest (mandatory and supplementary coverage). - `inv` number, double, required — Current invested share as an absolute amount. The remaining amount (cb minus inv) represents the cash/liquidity balance. - `bvg` number, double — BVG share as an absolute amount. - `rd` string, date, required — Reference date of vested benefit statement. - `ts` string, date-time, required — Date and time of generation of the VestedBenefitStatement. - `bch` boolean — 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. - `cyd` CapitalDevelopment — Shared capital development fields. - `cg` number, double — Total capital gains (positive) or losses (negative) from investments for the period. - `de` number, double — Total deposits or inflows for the period. - `fe` number, double — Total management or administrative fees for the period. Debits must be provided as a negative value. - `ic` number, double — Total interest credits for the period. - `wi` number, double — Total withdrawals or outflows for the period, e.g. for home ownership (WEF) or divorce settlements. Debits must be provided as a negative value. - `div` number, 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. - `p3y` object — If this field is present, then there is known purchase activity information for the last 3 years. Based solely on information available to this provider. If it is missing, this information is unknown. - `s` number, double, required — Cumulative purchase amount within the last 3 years. Based solely on information available to this provider. - `d` string, date — Date of the most recent purchase within the last 3 years. Based solely on information available to this provider. Omit this field if no purchase occurred within the last 3 years. - `plg` number, 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. - `wef` number, 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. ## 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)