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

Get Carrier

Your client ID. This will be shared with you during onboarding.

x-client-id

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!

x-client-secret

The unique ID for the requested carrier. Returned in Account and Policy objects as `carrier`.

Get Started

Axle

We're hiring!

Contact Us

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

Changelog

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

Overview

Start an Ignition session. Returns the ignitionUri to direct the user to authenticate.

Start Ignition

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

Ignition Status Handling

Exchange an authorization code for an access token. Ignition returns an authCode as a query parameter at the redirectUrl upon successful completion of the Ignition flow.

Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not expire.

Exchange 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 method will return an Account object including high-level account information (e.g., name) and any children objects (e.g., Policies) associated with the Account. Please note that this method will NOT refresh the Account object.

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 method returns a Policy object including high-level policy information (e.g., policy number) and any children objects (e.g., Coverages) associated with the Policy. Please note that this method will NOT refresh the Policy object.

Get Policy

The Get Carriers method returns an array of Carrier objects.

Get Carriers

The unique ID for the requested account. Returned as part of the Token Exchange flow in exchangeToken.

Set to *true* if you would like to expand related entities (e.g., account, policy). Defaults to *false*.

expand

The unique ID for the requested policy. Returned by Get Account for each Policy associated with the Account.

Set to *true* if you would like to request an update. Defaults to *false*.

refresh

Set to "relink-account" to start Ignition session to re-authenticate user. Must also provide `account`. 

type

Account

Address

Carrier

Connection

Coverage

Declaration Page

Document

Error

Insured

Policy

Property

Indicates whether the operation was performed successfully.

Success

Georgias Own Credit Union

Third Party

User to attach to Ignition session. If user is set, unique `id` must be provided.

Home

Guides

API Reference

Get Carrier

Headers

Path Parameters

Response

Home

Guides

API Reference

​Headers

​Path Parameters

​Response

Headers

Path Parameters

Response