Skip to navigation

Public pensions

View as Markdown

The public pensions the administration pays your customer.

One entry per pension — retirement, incapacity, widowhood — with its amounts and its dates. Field by field in Public Pensions.

An empty list is a meaningful answer, and the commonest one: it means the administration pays this person no pension today. It is not a failure, and it is not the same as the feature not having run.

Requires the public_pensions feature

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

These are public entitlements. A private pension plan is a bank product and comes from Pension plans.

StatusMeaning
200The pensions, possibly an empty list.
202feature_not_ready — public_pensions is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for public_pensions. 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
Pensions paid by the state: what kind, how much, since when, and under which régime. A private pension plan is a bank product and lives in its own endpoint.

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

product"social_security"
sub_family"social_security:spain_public_pension"
fetch_datestringformat: "datetime"
Date this product was fetched
product_namestring
Product name
start_datedate
Pension start date, when applicable
amountsobject
Amounts of the pension, when active
product_aliasstringOptional
Product alias
regimestringOptional
Pension regime

Errors

404
Not Found Error
422
Unprocessable Entity Error