Wealth API

The API allows you to collect and aggregate pension and investment data from a variety of companies.

This documentation contains a description of the methods available, examples of requests and responses and details about the returned objects.

Available companies

Check the Catalog to get the full list of companies supported.

A note on data - missing/null data points do not indicate zero/nothing value but should rather be viewed as unknown value.

Service availability

Due to technical issues and planned maintenance the supported companies may be unavailable time to time. Before starting a data collection, it is therefore recommended to first company statuses to obtain a status on which companies that are currently available.

Career statement (PDF)

For fr-info-retraite the wealth data can also include the end user's career statement (relevé de carrière) as a PDF. See FrenchCareerStatement for what it contains and how to download it.

Data collection example

Following is a step-by-step tutorial on how to obtain data through the API:

Collection statuses

Statuses without a version note are returned by every API version. A note such as 2026-04-01+ means the status is only returned by that version and later, and a market list such as ee/lt/lv means only those markets return it.

Authentication

Calls from your server authenticate with an API key, sent in the Authorization-token header. Send Insurely-Version on every request too (see API versioning).

Getting an API key

If your organisation uses the Insurely Hub, a customer admin can create and delete API keys there: open your client's settings and go to the API & Credentials tab. You can have several keys at once, so to rotate a key, create a new one, deploy it, then delete the old one. Without Hub access, email support@insurely.com and we'll provide one.

Keep API keys on your server. Never put them in a web page or mobile app.

Environments

Use the API key issued for the environment you call.

IP allowlist

Requests authenticated with an API key are only accepted from the IP addresses registered for your client. Send your servers' outbound IP addresses to support@insurely.com for each environment. A request from an address that isn't registered gets 401 with the message Authentication failed, the same response as an invalid key, so check both when you see it.

Demo companies

Demo companies let you run a full collection without a real login; this API's Demo companies page lists them and the test personal numbers. If one is missing from your GET /companies/availability response, ask us at support@insurely.com to enable it for your client.

API Versioning

Every request should send the Insurely-Version header with the date of the version you integrate against, such as 2026-04-01. The version these pages describe is shown in the API picker at the top of the sidebar.

If the header is missing, or names a version older than your client's minimum version, the API uses your client's minimum version instead. That is usually an older version than the one you are reading about, with different endpoints and fields, so always send the header.

Mutual TLS (mTLS)

Our APIs have support for mTLS. These are the steps needed to enable mTLS for your client.

genrsa -out my_test_client.key 2048
openssl req -new -key my_test_client.key -out my_test_client.csr
openssl genrsa -out my_prod_client.key 2048
openssl req -new -key my_prod_client.key -out my_prod_client.csr

curl --key my_test_client.key --cert my_test_client.pem  'https://mtls.api.test.insurely.com/health'
curl --key my_prod_client.key --cert my_prod_client.pem  'https://mtls.api.insurely.com/health'

{ "status": "healthy" }