Platform and integrations

API keys and webhooks

Partners and your own systems can quote, sell, report claims and record payments through the public API, and be told the moment things happen.

API keys

Integrations > API keys > New API key makes a key for a partner (a dealership, bank or travel site), a comparison site, a hospital system or your own system. Choose:

  • What it may do: read or create quotes, issue policies, report claims and send documents, read or record payments, read or create customers, health eligibility and claims.
  • Sells as: the agent or broker it is tied to. Its quotes and policies are credited to them, and it only sees their policies.
  • Requests a minute, an expiry date and the IP addresses allowed.
  • Live or Test: test keys work only on the test environment.

The key is shown once. Only its first characters and a fingerprint are kept; Roll the key makes a new one and stops the old one at once. Every call is logged with its answer and time.

The API

The reference is at /developers, with the OpenAPI description at /api/v1/openapi.json. Send the key as Authorization: Bearer ik_live_.... Creating a quote accepts an Idempotency-Key header, so a retried request never makes two quotes. Comparison sites can price all products at once with POST /api/v1/quotes/compare.

Webhooks

Integrations > Webhooks sends a message to a partner address when a claim is reported or changes status, a policy is issued or changes, a quote changes, an invoice becomes overdue or is paid, a payment arrives, and more. Each message is signed: the header X-InsureERP-Signature: t=<time>,v1=<HMAC-SHA256 of "time.body"> uses the secret shown when the webhook is made.

Failed deliveries are retried after 1, 5, 30, 120 and 720 minutes. After 10 failures in a row the webhook is switched off and an item goes to the exception queue. Each delivery can be opened and sent again.

Monitoring

Integrations > Monitor shows calls per key, refusals and failures, response times, webhook deliveries, data connections and recent imports.

Did not find what you need? Send us a message.