Axle’s Ignition session is the main interface that allows your customers to connect to their insurance accounts and authorize access to scoped data from their insurance policies.

Please first review our Quickstart guide and API docs on how to start an Ignition session, if you have not already.

Ignition Config

Your POST request to /ignition is configured with the following request body:

  • Optional: redirectUri - the URL we’ll redirect the user to upon completion, exit, or error outcomes of the Ignition session, defaults to no redirect
  • Optional: webhookUri - the URL we’ll send events to as the user proceeds through the Ignition session, defaults to no webhook events
  • Optional: user - optional user to attach, please refer to startIgnition for examples
  • Optional: metadata - optional Ignition session metadata, please refer to startIgnition for examples
Request Sample
curl --request POST \
  --url \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: cli_mZj6YGXhQyQnccN97aXbq' \
  --header 'x-client-secret: RZM-5BErZuChKqycbCS1O' \
  --data '{
  "redirectUri": "",
  "webhookUri": ""

Redirect Parameters

On navigation to the redirectUri provided, the URI will be appended with the following parameters:

status: String

  • complete
  • exit
  • error

Additional parameters (dependent on status, see below)

  • authCode: String - authorization code that can be exchange for accessToken for scoped access to connected account and/or policy
  • result: String - “link” (account connection was made and policy is available) OR “basic” (account connection was made but policy details are not available) OR “manual” (details were entered through manual collection form)
  • step: String - the step where the Ignition session was exited
  • message: String - additional information about the Ignition session error
Redirect sample URL

The authCode expires after 10 minutes, so ensure your backend service is exchanging codes through POST /token/exchange in real time.


When the user successfully connects to their carrier account and shares authorized access to a selected policy, OR when the user submits their policy information and/or documentation through Axle’s manual collection form.

  "status": "complete",
  "authCode": "<authCode>",
  "result": "link" || "basic" || "manual"


When the user opts out of connecting to their carrier account and/or selecting a policy, OR when the user opts out of sharing the requested policy information and/or documentation.

  "status": "exit",
  "step": "<step-name>"


When Axle is unable to retrieve account or policy information from a selected carrier, OR when Axle is unable to collect policy information and/or documentation from the user.

  "status": "error",
  "message": "<message-body>"

Never send requests from your client to the Axle API. The client should only be used to handle Ignition status through redirect.

Webhook Events

If an optional webhookUri is provided, a POST request will be sent to the webhookUri with the following body:

Example webhook request body
  "id": "<webhook_id>",
  "type": "ignition.completed",
  "data": {
    "token": "ign_Z4ni-JHBvkn9PlKJHPEwk",
  "createdAt": "2011-10-05T14:48:00.000Z"
ignition.createdtoken : String, user: Object, metadata: Object
ignition.completedtoken : String, user: Object, metadata: Object, authCode : String, result : String
ignition.openedtoken : String, user: Object, metadata: Object
ignition.exitedtoken : String, user: Object, metadata: Object, step : String
ignition.erroredtoken : String, user: Object, metadata: Object, message : String