French product types

Every product the API collects is returned as one of six objects. The objects are named after the data model rather than the products French customers know, so this page maps one to the other. The type field on each product says which object it is; see Type values.

Which companies return which products is in the Catalog.

Telling the products apart

FrenchLivret, FrenchInvestment and FrenchPension each carry a classification field that names the product. Its values are the spec's enum.

LifeInsurance has no classification: an assurance-vie contract is one product. FrenchPension also says whether the plan is INDIVIDUAL or COLLECTIVE (contractType), and both it and LifeInsurance say whether the holder manages it (LIBRE), the provider does (PILOTE) or both (HYBRIDE) in managementMode.

Assurance-vie is a savings product

Assurance-vie is France's largest savings and investment product. It is not protection cover, despite the name. LifeInsurance therefore looks like an investment account: it has holdings, a value, contributions and a management mode. The insurance side is limited to the insured person (insurance) and the conditions under which the contract pays out (payoutDetails).

Private and public retirement

France has two layers of retirement income, and the API returns them as different objects because they are different things.

• FrenchPension is a retirement savings plan the end user or their employer pays into: a PER in its individual (PERIN), company (PERECO) or mandatory company (PEROB) form, or one of the contracts the PER replaced, such as PERCO, PERP, Préfon, Article 83 and Madelin. It is collected either from the provider that holds it or from info-retraite, which lists the end user's retirement savings contracts and names the holding company in holdingCompany. It has holdings and a value like any other account.
• FrenchPublicPension is an estimate of the end user's future public pension, collected from fr-info-retraite, the official portal of the French pension schemes. The gross monthly amount adds up the basic, complementary (such as Agirc-Arrco) and supplementary mandatory schemes. One object is returned per retirement scenario, at the legal retirement age and at the full-rate age, each with its departure age and date and the registered quarters. It has no holdings.

The career statement is a document, not an account

FrenchCareerStatement sits in the same list because it is delivered through the same endpoint, but it is a file: the relevé de carrière as issued by info-retraite, in French, with employers, reported income per year and validated quarters. Insurely does not extract structured data from it. See FrenchCareerStatement for how to download it.

Type values

The type value on a product and the object it is returned as: