Objects

Financial Product

Details of financial products such as pensions and investments accounts.

Extended by: FrenchPension, PEA, LifeInsurance, CTO, FrenchPublicPension
companystring

Company where the financial product has been collected from.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

typestring

Type of the financial product.

Possible Enum values are PER, PEA, LIFE_INSURANCE, CTO or FRENCH_PUBLIC_PENSION.
One of these types:

Properties below are from the FrenchPension subtype. View the full schema for full details.

classificationstring

Classification of the pension.

Possible Enum values are PERIN, PEROB, PERECO, PERCO, PERP, PREFON, ARTICLE83, MADELIN or GENERIC.
companystring

Company where the financial product has been collected from. Examples: fr-info-retraite

companyDisplayNamestring

Display name of the company for user-friendly presentation.

productNamestring
productNumberstring
startDatestring
dataSourcestring

Indicates how the account data was obtained. AUTOMATIC means the data was collected via an aggregator connection. MANUAL means the account was added manually by the user. Defaults to AUTOMATIC.

Possible Enum values are AUTOMATIC or MANUAL.
updateDatestring

Date when value was last updated (format YYYY-MM-DD)

holdingCompanyFrenchHoldingCompany
managementModestring

Management mode of the pension.

Possible Enum values are HYBRIDE, LIBRE or PILOTE.
contractTypestring

Whether the pension contract is held individually by the policy holder or as part of a collective (employer-sponsored) plan.

Possible Enum values are INDIVIDUAL or COLLECTIVE.
activeAdditionalContributionsboolean
transactionsArray<Transaction>

Transaction history for the last 12 months.

idstring
typestring

Type of the financial product.

Possible Enum values are PER.
Example
{  "company": "fr-info-retraite",  "companyDisplayName": "Company",  "type": "PER"}