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

  1. Use the collectionId from the response to get data from that collection by using the Insurance or Pension API - GET /(insurance|pension)-collection/get-data/{collectionId}

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

  1. Use the collectionId from the response to get data from that collection by using the Insurance or Pension API.
  1. Use the collectionId from the response to get cancellations for insurances in that collection by using the Cancellation API.

Authentication

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

HeaderHeader Value
Authorization-tokenYour API key
Api-VersionThe API version you integrate against, for example 2026-04-01

Getting an API key

If your organisation uses the Anessa 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@anessa.co and we'll provide one.

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

Base URL

All requests go to https://api.anessa.co.

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@anessa.co. 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 Api-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.

HeaderHeader Value
Api-VersionThe version of the API, as YYYY-MM-DD

Moving from Insurely-Version

Api-Version replaces the Insurely-Version header. Both take the same value, and the rename changes nothing else about a request or its response.

  • Insurely-Version keeps working for API versions up to and including 2026-04-01.
  • Versions after 2026-04-01 accept only Api-Version. A request that sends Insurely-Version with a later version returns 400.
  • Send only one of the two headers. A request that sends both returns 400.

To migrate, rename the header in your requests. You can do that today, on the version you already use.

Mutual TLS (mTLS)

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

Create a private key and a Certificate Signing Request (CSR) and send the CSR to support@anessa.co. We will sign it and send the certificate back.

openssl genrsa -out my_client.key 2048
openssl req -new -key my_client.key -out my_client.csr

Verify your received certificate

curl --key my_client.key --cert my_client.pem  'https://mtls.api.insurely.com/health'

You should get this response:

{ "status": "healthy" }

To enforce mTLS, prefix all URLs with the mtls subdomain as shown in the verification example above.