Routes
Get the wealth data of a collection
GEThttps://api.insurely.com/wealth/collection/{collectionId}/data
Request
Path Parameters
collectionIdstring
Header Parameters
Insurely-Versionstring
Specifies the API version to use. Must match the version of the endpoint you are targeting.
Possible Enum values are
2025-01-01.Responses
Pension data successfully fetched.
Body
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 or CTO.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 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
holderFrench.Holder
insuranceFrench.Insurance
startDatestring
updateDatestring
Date when value was last updated (format YYYY-MM-DD)
payoutDetailsArray<French.PayoutDetail>
financialInformationFrench.ProductFinancialInformation
holdingsArray<French.FrenchHolding>
holdingCompanyFrenchHoldingCompany
managementModestring
Management mode of the pension.
Possible Enum values are
HYBRIDE, LIBRE or PILOTE.activeAdditionalContributionsboolean
transactionsArray<Transaction>
Transaction history for the last 12 months.
idstring
typestring
Type of the financial product.
Possible Enum values are
PER.cURL
curl https://api.insurely.com/wealth/collection/{collectionId}/data