# Axle - [Welcome](https://docs.axle.insure/welcome.md): 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 Goo… - [Security](https://docs.axle.insure/security.md): 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. - [Changelog](https://docs.axle.insure/changelog.md): Latest updates to the Axle API - [Quickstart](https://docs.axle.insure/guides/quickstart.md): 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. - [Initialize](https://docs.axle.insure/guides/initialize-ignition.md): This guide will help you understand how to display Axle's Ignition session to your users. - [Proxy](https://docs.axle.insure/guides/proxy-ignition.md): As an alternative to initializing Ignition, proxy insurance information on behalf of your user to Axle for processing and/or verification. - [Events](https://docs.axle.insure/guides/ignition-events.md): This guide will walk you through the various events that occur during an Ignition session. - [Results](https://docs.axle.insure/guides/completion-types.md): Understanding the different completion results of an Axle Ignition session. - [Optimizing conversion with Axle Ignition](https://docs.axle.insure/guides/optimizing-ignition-conversion.md): Learn how to optimize your implementation of Axle Ignition, Axle’s embedded insurance verification flow. This guide outlines best practices to maximize user conversion by presenting Axle as the default, setting expectations, and minimizing friction. - [Axle for Platforms](https://docs.axle.insure/guides/platform-integration.md): Integrate Axle's API into your platform, to provide instant insurance verification solutions for your customers. - [Overview](https://docs.axle.insure/guides/monitoring.md): Receive proactive notifications for updates to an insurance policy, such as policy cancellation or change in coverages. - [Account events](https://docs.axle.insure/guides/account-events.md): This guide will walk you through the various Account events that may occur when monitoring an insurance account. - [Policy events](https://docs.axle.insure/guides/policy-events.md): This guide will walk you through the various Policy events that may occur when monitoring an insurance policy. - [Policy Validation](https://docs.axle.insure/guides/validate/policy-validation.md): Evaluate a set of Rules against a policy to determine if your application's requirements are met. - [Policy Validation with Templates](https://docs.axle.insure/guides/validate/policy-validation-with-template.md): Templates let you evaluate a set of Rules against a policy by storing rules and inputs, and pulling dynamic values from custom metadata. - [Widgets](https://docs.axle.insure/guides/widgets.md): This guide will help you understand how to display Axle's embeddable widgets to your users. - [Policy Actions](https://docs.axle.insure/guides/policy-actions.md): Execute an action on a policy on behalf of your user. - [Testing Ignition](https://docs.axle.insure/guides/sandbox/ignition-completion.md): 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. - [Monitoring notifications](https://docs.axle.insure/guides/sandbox/monitoring-notifications.md): Test in Sandbox environment notification for monitoring enabled accounts and policies - [Validate Policy with Template](https://docs.axle.insure/guides/sandbox/validate-policy-with-template.md): Evaluate a set of Rules against a policy to determine if your application’s requirements are met. - [Overview](https://docs.axle.insure/api-reference/overview.md): Learn about the Axle API - [Start Ignition](https://docs.axle.insure/api-reference/ignition/start-ignition.md): Generate an Ignition session. Returns an ignitionToken and ignitionUri to direct the user to share their insurance information. The ignition session will never expire. - [Proxy Ignition](https://docs.axle.insure/api-reference/ignition/proxy-ignition.md): Proxy insurance information on behalf of your user to Axle for processing and/or verification. This endpoint should ONLY be used when insurance information is gathered when the user is not present (such as a document received from an insurance carrier via mail). - [Exchange Token](https://docs.axle.insure/api-reference/tokens/exchange-token.md): 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. - [Descope Token](https://docs.axle.insure/api-reference/tokens/descope-token.md): 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. - [The Account object](https://docs.axle.insure/api-reference/accounts/account.md): 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. - [Get Account](https://docs.axle.insure/api-reference/accounts/get-account.md): 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… - [The Policy object](https://docs.axle.insure/api-reference/policies/policy.md): 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. - [Coverages](https://docs.axle.insure/api-reference/policies/coverages.md): 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. - [Get Policy](https://docs.axle.insure/api-reference/policies/get-policy.md): 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 Report](https://docs.axle.insure/api-reference/policies/get-policy-report.md): 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. - [Execute Policy Action](https://docs.axle.insure/api-reference/policies/execute-policy-action.md): Execute an action on a policy on behalf of your user. Once submitted, Axle will process the request. - [Get Carrier](https://docs.axle.insure/api-reference/carriers/get-carrier.md): The Get Carrier endpoint returns a Carrier object that include additional details (such as image) about an Axle-supported insurance carrier. - [Get Carriers](https://docs.axle.insure/api-reference/carriers/get-carriers.md): The Get Carriers endpoint returns an array of Carrier objects which include additional details about Axle-supported insurance carriers. - [Create Client](https://docs.axle.insure/api-reference/platform/create-client.md): Create a destination client associated with your platform client. 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. - [Get Clients](https://docs.axle.insure/api-reference/platform/get-clients.md): Get a list of destination clients associated with your platform client. 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. - [Create Template](https://docs.axle.insure/api-reference/platform/create-templates.md): Create a new template for all of your destination clients. - [Trigger Account event](https://docs.axle.insure/api-reference/sandbox/trigger-account-event.md): The Account event will be sent to the `webhookUri` specified when generating an Ignition token. - [Trigger Policy event](https://docs.axle.insure/api-reference/sandbox/trigger-policy-event.md): The Policy event will be sent to the `webhookUri` specified when generating an Ignition token. - [Validate Policy](https://docs.axle.insure/api-reference/validation/validate-policy.md): The Validate Policy endpoint returns the result of a evaluating a series of Rules against the requested policy object. For details about each Rule and their return types, see the [Policy Validation Guide](/guides/validate/policy-validation). - [Validate Policy with Template](https://docs.axle.insure/api-reference/validation/validate-policy-template.md): The Validate Policy with Template endpoint returns the result of a evaluating a template of Rules against the requested policy object. - [Create Template](https://docs.axle.insure/api-reference/validation/templates/create-template.md): Create a new template for your client. - [Get Template](https://docs.axle.insure/api-reference/validation/templates/get-template.md): The Get Template endpoint returns template object for provided template ID. - [Update Template](https://docs.axle.insure/api-reference/validation/templates/update-template.md): The Update Template endpoint updates a Template object. This endpoint will upsert template for provided `clientId` or `destinationId`. - [Get Templates](https://docs.axle.insure/api-reference/validation/templates/get-templates.md): Get a list of all templates for the provided `clientId` or `destinationId`. - [Start Widget](https://docs.axle.insure/api-reference/widgets/start-widget.md): Generate a widget session. Returns a widgetToken and widgetUri to display Axle's embeddable widget experience to the user. Currently, `validation` is the only supported widget type. - [Ignition Events](https://docs.axle.insure/api-reference/webhooks/ignition-events.md): Sent to your `webhookUri` (configured on [Start Ignition](/api-reference/ignition/start-ignition)) as the user progresses through an Ignition session. These events also fire for [Proxy Ignition](/api-reference/ignition/proxy-ignition) operations. See [Ignition Events](/guides/ignition-events) for mo… - [Account Events](https://docs.axle.insure/api-reference/webhooks/account-events.md): Sent to your `webhookUri` as Axle monitors an insurance account connected through an Ignition session configured with `monitoring` enabled. See [Account Events](/guides/account-events) for more details. - [Policy Events](https://docs.axle.insure/api-reference/webhooks/policy-events.md): Sent to your `webhookUri` as Axle monitors an insurance policy connected through an Ignition session configured with `monitoring` enabled. See [Policy Events](/guides/policy-events) for more details. - [Policy Action Events](https://docs.axle.insure/api-reference/webhooks/policy-action-events.md): Sent to your `webhookUri` at each stage of a [Policy Action](/guides/policy-actions)'s lifecycle: `policy-action.request-initiated` -> `policy-action.request-succeeded` or `policy-action.request-failed` -> (on success) `policy-action.policy-refresh-succeeded` or `policy-action.policy-refresh-failed`… - [MCP](https://docs.axle.insure/advanced/mcp.md): Set up Axle's MCP to grant AI tools the knowledge of Axle docs ## OpenAPI Specs - [openapi](/openapi.yaml) ## Optional - [Get Started](https://www.axle.insure/contact) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.