Overview

When embedding insurance verification into your application, you may want to evaluate whether a shared insurance policy meets your business’ requirements. Each supported Rule is an individual check evaluated against the Policy object to determine if the Policy meets a certain requirement or set of requirements.

For example, the policy-active Rule checks if the policy is currently active, evaluating to pass if the isActive field of the policy is true and fail if it is false. If isActive is null (not provided by the insurance carrier), this Rule will resolve to unknown.

Some Rules are more complex, providing additional insight not found on the Policy object. For example, the rental-covered-for-collision Rule provides guidance on whether a policy affords coverage for collision damage when an insured is driving a rental vehicle.

Some Rules require additional input to be evaluated. For example, the expiration-date-comparison Rule requires an input date to compare against the policy’s expiration date. For more details on the additional inputs that a Rule may require, refer to Supported Rules.

Each Rule evaluates to one of the following statuses:

StatusDescription
passThe policy meets all requirements of the Rule
failThe policy does not meet all the requirements of the Rule
cautionThe policy only partially meets the requirements of the Rule or the Rule returns an inconclusive outcome.
unknownNot enough data was available to determine the outcome of the Rule

Requesting Evaluation Rules

You can request that a Policy be evaluated against a specified set of Rules through the Validate Policy endpoint. Each Rule you requested will be run, and you’ll receive a response with an overall status determination of either pass, fail, or caution.

  • pass means that the policy succeeded in passing against all of the specified Rules.
  • fail means that one or more specified Rules evaluated to a status of fail.
  • caution means that one or more specified Rules evaluated to a status of caution. In most cases, it is recommended to complete a manual review of the policy.

The response also contains two other fields:

  • summary - An object containing the names of all Rules on the policy and their resolved statuses.
  • rules - An object containing the names of each Rules and their run details.
{
  "status": "pass",
  "summary": {
    "policy-active": "pass",
    "rental-covered-for-collision": "pass",
  },
  "rules": {
    "policy-active":{
      "status": "pass",
      "metadata": {...},
    },
    "rental-covered-for-collision": {
      "status": "pass",
      "breakdown": {...},
      "metadata": {...}
    }
  }
}

Supported Rules

The Axle team is actively working on adding additional supported Rules. Please reach out with any suggestions!

Validation Templates

Templates can be used to simplify the configuration of Rules in your application by storing the list of rules with any default inputs. Validation Templates can also access dynamic input values from custom metadata shared via Start Ignition or individual Validate request.

Validation Templates are currently in development. Please reach out to the Axle team if you would like to enable them for your client or platform.

Example Template

{
  "id": "tem_jsK9vrCIfABlCW7PqIknc",
  "rules": [
    {
      "rule": "collision-coverage-meets-requirements",
      "input": {
        "vin": {
          "source": "customerVin", // Key of dynamic value from Ignition metadata
          "default": "WMWRC33404TJ15309" // Optional default input value, will be overridden by dynamic value if provided
        }
      }
    }
  ],
  "createdAt": "2025-06-10T13:57:22.300Z",
  "modifiedAt": "2025-06-10T13:57:22.300Z"
}

Usage

1

Create or modify Validation Template

Note: Currently, Axle does not support creating or modifying templates via API. We hope to launch this in the near future. Please reach out to the Axle team to configure your Templates.

2

Provide dynamic inputs to Ignition metadata (optional)

Include metadata in Start Ignition to serve as dynamic Rule inputs. Ensure the metadata object is formatted correctly with the keys specified in your Template and the values conforming to the associated Rule input(s).

3

Retrieve Validation Templates

After creating a template, you can store the Template identifier in your application or retrieve a list of Templates configured for your Axle client or destination client when needed.

See Get Validation Config for more details.

4

Request Policy Validation with Template

Use the Template identifier to make a request to Validate Policy with Template. Ensure the request object is formatted correctly with the keys specified in your Template and the values conforming to the associated Rule input(s).

Providing inputs to the Validate Policy endpoint will overwrite any metadata provided via Start Ignition.