Skip to navigation
Fetching the resultsFinancial Data

Pension plans

View as Markdown

Private pension plans held at the institution.

Each plan carries its identifiers, the accumulated balance, the contributions recorded and the valuation the institution publishes. Field by field in Investments.

This is the private side of retirement saving. What the state pays comes from the administration instead, through Public pensions — a different source, a different feature, and frequently a different answer.

Requires the pensions_read feature

Features are chosen when the execution starts, not here. An execution that did not ask for pensions_read answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The plans.
202feature_not_ready — pensions_read is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for pensions_read. No body.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Private pension plans held at the institution — the ones a person contracts. The state pension is a public record and lives in its own endpoint.

An empty list is an answer, not a gap: the feature ran and the source reported none.

idstringformat: "object-id"

Product ID for the current execution. Note: it may change between executions.

product"pension_plan"
sub_familyenum
Pension plan type
Allowed values:
fetch_datestringformat: "datetime"
Date this product was fetched
identifierobject
Plan number
customer_segmentenum
product_namestring
Product name
linked_accountobjectOptional
Account identifier
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
categorystringOptional
Plan Category
begin_datedateOptional
Begin date
end_datedateOptional
End Date
total_contributionobjectOptional
Total contribution
year_to_date_contributionobjectOptional
Year to date contribution
unit_priceobjectOptional
Unit price
quantitystringOptionalformat: "number"Defaults to nan
The number of units of a financial instrument held by the account.
valuationobjectOptional
The monetary value of a financial instrument held by the account.
valuation_datedateOptional
Valuation date
performanceobjectOptional
Total Performance
performance_year_to_dateobjectOptional
Year to date performance
performance_last_12_monthsobjectOptional
Last 12 months performance
appreciationobjectOptional
The monetary value of the appreciation of a financial instrument held by the account.

Errors

404
Not Found Error
422
Unprocessable Entity Error