Routes

Get wealth collection data

GEThttps://api.insurely.com/collections/{collectionId}/wealth/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 2026-04-01.

Responses

Wealth data successfully fetched.

Body

companystring

Company where the financial product has been collected from, in the format {market}-{company}.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

typestring

Type of the financial product.

Possible Enum values are FRENCH_PENSION, FRENCH_INVESTMENT, LIFE_INSURANCE, FRENCH_PUBLIC_PENSION, LIVRET or FRENCH_CAREER_STATEMENT.
One of these types:

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

activeAdditionalContributionsboolean

Whether the holder is currently making additional contributions to the contract.

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. Example: fr-info-retraite.

companyDisplayNamestring

Display name of the company for user-friendly presentation.

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.
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.
holdingCompanyFrenchHoldingCompany
holdingsArray<FrenchHolding>

List of holdings within the pension.

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.

insuranceInsurance
managementModestring

Management mode of the pension.

Possible Enum values are HYBRIDE, LIBRE or PILOTE.
payoutDetailsArray<FrenchPayoutDetail>

Conditions describing when and how the pension is paid out.

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.

startDatestring

Date when the pension contract was opened.

transactionsArray<Transaction>

Transaction history for the last 12 months.

typestring

Type of the financial product.

Possible Enum values are FRENCH_PENSION, FRENCH_INVESTMENT, LIFE_INSURANCE, FRENCH_PUBLIC_PENSION, LIVRET or FRENCH_CAREER_STATEMENT.
updateDatestring

Date when the pension was last updated by the institution.

cURL
curl https://api.insurely.com/collections/{collectionId}/wealth/data \
  -H "authorization-token: <authorization-token>"
RESPONSE 200
[
  {
    "company": "fr-info-retraite",
    "companyDisplayName": "Info Retraite",
    "document": {
      "id": "e3a1f0c7-52b4-4c9d-9f11-6d8a2b4c7e05"
    },
    "id": "b4c1ec96-182b-4533-98e1-7060d9643928",
    "productNumber": "PRM00321-1131",
    "type": "FRENCH_CAREER_STATEMENT"
  }
]