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

Retrieve collection data.

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}

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 Insurely.

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

Suggested usage example

Retrieve sessions.

Use the collectionId from the response to get data from that collection by using the Insurance or Pension API.

Use the collectionId from the response to get cancellations for insurances in that collection by using the Cancellation API.

Authentication

To use the API you need to obtain an authentication token. This key is to be set in the header ´Authorization-token` for all requests. E-mail us at support@insurely.com and we'll provide the API key.

Header	Header Value
Authorization-token	The auth key supplied by Insurely

API Versioning

The API will default to the lowest running API version. If you want to use a newer version you must set the Insurely-Version header on your requests, with the date of the version that you intend to use. The API version that this document references is specified at the top of this page.

Header	Header Value
Insurely-Version	The version of the API

Mutual TLS (mTLS)

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

Create two private keys and two Certificate Signing Requests (CSR), one for test and one for production, and send them to support@insurely.com. Insurely will sign and send the certificates back.

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

Verify your received certificates

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'

You should get the same response for both requests:

{ "status": "healthy" }

To enforce mTLS - prefix all urls with the mtls subdomain as shown in verification examples above.