Get Started

Axle

We're hiring!

Contact Us

The Get Carrier endpoint returns a Carrier object that include additional details about an Axle-supported insurance carrier.

Get Carrier

Address

Carrier

State Farm

Indicates whether the operation was performed successfully.

Success

ApiKeyAuth

Axle is a universal API for insurance data. With Axle, companies can instantly verify insurance and monitor ongoing coverage, helping them create a frictionless experience for their users and reduce operational risk through better-informed decisions. Axle is backed by leading investors including Google and Y Combinator.

Welcome

At Axle, security and privacy are at the forefront of everything we do. We leverage the latest in cloud infrastructure and weave secure-by-design and privacy-by-design principles into our engineering DNA.

Security

Axle's powerful API makes it easy for you to quickly retrieve detailed information from your users' insurance policies. Here at Axle, we're champions for consumer data control and privacy, so you'll need to gain consent from the user to access their information.

Quickstart

This guide will help you understand how to display Axle's Ignition session to your users.

Initialize

This guide will walk you through the various events that occur during an Ignition session.

Events

Integrate Axle's API into your platform, to provide instant insurance verification solutions for your customers.

Axle for Platforms

Receive proactive notifications for updates to an insurance policy, such as policy cancellation or change in coverages.

Overview

This guide will walk you through the various Account events that may occur when monitoring an insurance account.

Account events

This guide will walk you through the various Policy events that may occur when monitoring an insurance policy.

Policy events

The Axle sandbox can be used to test your integration of Axle's API in your application or platform. All Axle API endpoints can access the sandbox environment.

Sandbox

Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire.

Start Ignition

Exchange an authorization code returned by an `ignition.completed` event for an access token. Follow the [Quickstart](/guides/quickstart) or see [Ignition Events](/guides/ignition-events) for more details.

Auth codes are single-use and expire after 10 minutes, while accessTokens do not expire.

Exchange Token

Reduce scope for a specified access token. For example, de-scoping `monitoring` will disable Axle monitoring and you will no longer receive notifiations on Account or Policy events.

Descope Token

An Account represents an account with an insurance carrier and includes high-level account information (e.g. name) and any Policy objects associated with the Account.

The Account object

The Get Account endpoint will return an Account object including high-level account information (e.g., connection status) and any children objects (e.g., Policies) associated with the Account.
Please note that this endpoint will NOT refresh the Account object with new data from the insurance carrier.

Get Account

A Policy represents a specific policy associated with an Account and includes high-level policy information (e.g. policy number) and any children objects (e.g., coverages) associated with the policy.

The Policy object

The Get Policy endpoint returns a Policy object. Please refer to the [Policy](/api-reference/policies/policy) object for a detailed description of each field.
Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.

Get Policy

The Get Policy Report endpoint returns a PDF or image report of the requested Policy object. Please refer to the [Policy](/api-reference/policies/policy) object for a detailed description of each field.

Get Policy Report

This page provides additional detail about the Axle Schema's insurance coverage types and highlights key rules and checks used to ensure accurate data. Coverages are provided through the `coverages` array in Policy objects.


Coverages

The Get Carriers endpoint returns an array of Carrier objects which include additional details about Axle-supported insurance carriers.

Get Carriers

Create a destination client associated with your platform client and secret. This request will return a destination client `id` that you can use to make requests to the Axle API on behalf of your destination clients.

See the [Axle for Platforms](/guides/platform-integration) guide for more information on how to use this endpoint and the destination client `id`.

Create Client

Get a list of destination clients associated with your platform client and secret. This request will return a list of destination client `id`s that you can use to make requests to the Axle API on behalf of your destination clients.

See the [Axle for Platforms](/guides/platform-integration) guide for more information on how to use this endpoint and the destination client `id`.

Get Clients

The Account event will be sent to the `webhookUri` specified when generating an Ignition token. 

Refer to the [Sandbox](/guides/sandbox) guide for more details.

Trigger Account event

The Policy event will be sent to the `webhookUri` specified when generating an Ignition token. 

Refer to the [Sandbox](/guides/sandbox) guide for more details.

Home

Guides

API Reference

Get Carrier

Authorizations

Headers

Path Parameters

Response