Objects

French Pension

French Pension. Example: PER

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
{  "classification": "PEROB",  "company": "fr-info-retraite",  "id": "b4c1ec96-182b-4533-98e1-7060d9643928",  "financialInformation": {    "currentValue": {      "amount": 150,      "currency": "EUR"    },    "currentValueFormula": "2497 Point(s) d'une valeur unitaire de 1,9076 €",    "changeValue": {      "amount": 15,      "currency": "EUR"    }  },  "holder": {    "name": "test",    "organization": {      "name": "GE VERNOVA INTERNATIONAL LLC"    }  },  "holdingCompany": {    "address": {      "fullAddress": "CREDIT AGRICOLE ASSURANCES RETRAITE, TSA 76005, 26906 VALENCE CEDEX 9, FRANCE"    },    "name": "CREDIT AGRICOLE ASSURANCES RETRAITE",    "phoneNumber": "0437470034"  },  "holdings": [    {      "isin": "FR0010315770",      "name": "AMUNDI ETF CAC 40",      "quantity": 54.076858,      "type": "FUND",      "value": {        "amount": 22468.39,        "currency": "EUR"      },      "changeValue": {        "amount": 100.39,        "currency": "EUR"      },      "acquisitionValue": {        "amount": 18883.51,        "currency": "EUR"      },      "srri": 4    }  ],  "transactions": [    {      "amount": {        "amount": 10.32,        "currency": "EUR"      },      "description": "Versement",      "settlementDate": "2024-01-01",      "type": "DEPOSIT"    }  ],  "insurance": {    "insuredPersonName": "Juliette DUPONT GIRARD"  },  "payoutDetails": [    {      "description": "A compter de la date de départ à la retraite."    }  ],  "productName": "Plan Epargne Retraite Obligatoire - loi Pacte",  "productNumber": "PRM00321-1131",  "startDate": "2021-06-15",  "type": "PER",  "updateDate": "2024-04-18",  "managementMode": "HYBRIDE",  "contractType": "INDIVIDUAL",  "activeAdditionalContributions": false}