Export API

The Export API provides bulk export of metadata, useful for importing your data into other systems.

Exporting collections

The collection export operation provides an export of collection metadata, which can be used in combination with the Insurance or Pension data APIs to export data into other systems.

Suggested usage example

Exporting sessions

The session export operation enables retrieving sessions data. Such data includes: the creation date of the session, the email of the insurance advisor the session belongs to (if the session is assigned to an advisor), the set of collections that have been started under that session (just the collection identifier and the collection creation date), other session data (such as contact information for the person the session was created for, and additional metadata).

When used in combination with the Insurance, Pension and Cancellation API, you can attain a thorough picture of your insurance advisors' activities within our platform.

Refer to the Session API documentation for information pertaining session creation.

Suggested usage example

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.

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" }