Life Insurance

French Life Insurance (Assurance Vie) Account

companystring

Company where the financial product has been collected from. Examples: fr-hello-bank.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

productNamestring

Name of the financial product.

productNumberstring

The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.

holderFrench.Holder

Information about the owner of the financial product.

insuranceFrench.Insurance

Details about the insured person.

startDatestring

Contract start date (format YYYY-MM-DD)

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.

payoutDetailsArray<French.PayoutDetail>

Details about the payout.

financialInformationFrench.ProductFinancialInformation

Financial details of the product, like value and performance.

holdingsArray<French.FrenchHolding>

List of holdings within the financial product.

holdingCompanyFrenchHoldingCompany

Information about the company holding the life insurance.

managementModestring

Management mode of the life insurance.

Possible Enum values are HYBRIDE, LIBRE or PILOTE.

activeAdditionalContributionsboolean

Whether additional contributions are currently active.

transactionsArray<Transaction>

Transaction history for the last 12 months.

idstring

Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., productNumber, accountNumber, or loanId) for that.

typestring

Type of the financial product.

Possible Enum values are LIFE_INSURANCE.

Example

{
  "company": "fr-hello-bank",
  "companyDisplayName": "Hello Bank",
  "productName": "Mon Assurance Vie",
  "productNumber": "FR91231230-2",
  "holder": {
    "name": {},
    "organization": {}
  },
  "insurance": {
    "insuredPersonName": "Juliette DUPONT GIRARD"
  },
  "startDate": "2021-06-15",
  "dataSource": "AUTOMATIC",
  "payoutDetails": [],
  "financialInformation": {
    "currentValue": {},
    "currentValueFormula": {},
    "changeValue": {}
  },
  "holdings": [],
  "holdingCompany": {
    "address": {},
    "email": "contact@company.fr",
    "name": "CREDIT AGRICOLE ASSURANCES RETRAITE",
    "phoneNumber": "0437470034"
  },
  "managementMode": "HYBRIDE",
  "activeAdditionalContributions": false,
  "transactions": [],
  "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552",
  "type": "LIFE_INSURANCE"
}

{  "company": "fr-hello-bank",  "companyDisplayName": "Hello Bank",  "productName": "Mon Assurance Vie",  "productNumber": "FR91231230-2",  "holder": {    "name": {},    "organization": {}  },  "insurance": {    "insuredPersonName": "Juliette DUPONT GIRARD"  },  "startDate": "2021-06-15",  "dataSource": "AUTOMATIC",  "payoutDetails": [],  "financialInformation": {    "currentValue": {},    "currentValueFormula": {},    "changeValue": {}  },  "holdings": [],  "holdingCompany": {    "address": {},    "email": "contact@company.fr",    "name": "CREDIT AGRICOLE ASSURANCES RETRAITE",    "phoneNumber": "0437470034"  },  "managementMode": "HYBRIDE",  "activeAdditionalContributions": false,  "transactions": [],  "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552",  "type": "LIFE_INSURANCE"}