Skip to main content

​
Overview

Axle’s Ignition session is the main interface that allows your users to connect to their insurance accounts and authorize access to scoped data from their insurance policies. However, sometimes insurance information is shared to you on behalf of your user, such as when an insurance carrier or agent sends documents via mail directly to the policy lienholder. In these cases, you can “proxy” an Ignition session, effectively sharing information on behalf of your user instead of initializing Ignition for the user to complete it themself. Axle will then process and/or verify this information, depending on the use case.
When proxying an Ignition session, you are agreeing that you have received consent from user to share their insurance information with Axle, a data processor, as persuant to Axle’s Privacy Policy and End User Terms.
1

Configure Ignition to receive webhooks

Ensure that the request made to generate an Ignition token includes the webhookUri where you would like to receive Ignition events.
Request Sample: cURL
curl --request POST \
  --url https://api.axle.insure/ignition \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: cli_mZj6YGXhQyQnccN97aXbq' \
  --header 'x-client-secret: RZM-5BErZuChKqycbCS1O' \
  --data '{
  "webhookUri": "https://example.com/webhook",
  "user": {"id": "usr_123456789"}
}'
2

Send proxy request

Select a supported operation and provide the required insurance information for the operation in the POST /ignition/{ignitionToken}/proxy request body. See Proxy Ignition API reference for more details on how to invoke the Proxy Ignition endpoint.
When Proxy Ignition request is made, Axle will queue the proxy operation immediately. Completion times may vary by operation and current Axle volume, but will be under 24 hours.
3

Process Ignition events

Once the submitted insurance information has been processed and/or verified, an POST request will be sent to the webhookUri specified when generating the Ignition session. See Ignition events for more details on the payloads of each event.
  • ignition.completed
  • ignition.errored
Continue from Step 3 in the Quickstart guide. In summary, you will need to exchange the short-lived authCode specified for an accessToken, which can then be used to retrieve Axle Account and Policy objects.
The result of the ignition.completed event will be the selected proxy operation. If you are using the same webhookUri across proxied and non-proxied Ignition sessions, you can use this result to filter the events.

​
Supported operations

Currently, only certain Ignition proxy operations are supported. Please reach out to the Axle team if you would like to request new operations.
Leverage Axle’s Document AI to extract information from a policy document, such as a declarations page, policy renewal, ID card, or new business binder, and transform it into an Axle Policy object.In the request body, you must provide the following:
  • operation: process-document
  • input:
    • name for the document (such as the unique identifier of the document in your system)
    • source of the document (either user or carrier)
    • policyType of the document (auto or home)
    • url that can used to access the document.
    This operation supports documents in the following formats: pdf, jpg, jpeg, and png. The url must directly serve the document via a HTTP GET request. For security, it is recommended to use a url with an 24-hour expiry, such as an AWS S3 signed url.
Example request body
{
  "operation": "process-document",
  "input": {
    "name": "DOC_ABC",
    "source": "carrier",
    "policyType": "auto",
    "url": "https://your-document-bucket.s3.amazonaws.com/declarations-page.pdf"
  }
}
If the operation does not succeed, one of the following messages will be returned as part of the ignition.errored event, which you can use to determine next steps.
  • Document data is empty. - The document had no data.
  • Failed to download the file from the specified url. - The file could not be downloaded from the specified url. Please ensure that the url directly serves the document.
  • Please make sure to upload an image or pdf document with your policy information clearly legible. - The document was not supported by Axle’s DocumentAI as it is either the wrong format, not legible, or not an insurance document.
  • Oops something went wrong. Please try again later. - An unknown error occured. Retrying may result in a successful operation.