Evaluate a set of Rules against a policy to determine if your application’s requirements are met.
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:
Status | Description |
---|---|
pass | The policy meets all requirements of the Rule |
fail | The policy does not meet all the requirements of the Rule |
caution | The policy only partially meets the requirements of the Rule or the Rule returns an inconclusive outcome. |
unknown | Not enough data was available to determine the outcome of the Rule |
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.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.Policy is Active
policy-active
Status | Cause |
---|---|
pass | The policy is currently active |
fail | The policy is not currently active |
caution | The isActive field is null , meaning Axle could not confirm the isActive status with the carrier |
unknown | The isActive field is undefined , meaning it’s a manual policy |
Rental Vehicle is Covered For Collision Damage
rental-covered-for-collision
rental-covered-for-collision
Rule resolves to pass
.rental-covered-for-collision
recommendation may not apply the following scenarios:Status | Cause |
---|---|
pass | The policy is likely to cover an insured for collision damage to their rental vehicle either because of their personal collision coverage or due to state regulations. |
fail | The policy is unlikely to provide coverage for collision damage to a rental vehicle. |
caution | The Rental Coverage Validation AI is not confident in its recommendation. |
unknown | The policy cannot be matched to the required resources to make a recommendation. |
Message Code | Evaluation Status | Message |
---|---|---|
coll-extends-to-rental | pass | The policy has collision coverage and the matching policy agreements indicate that collision coverage extends to rental vehicles. |
pd-covers-rental-collision | pass | The policy is underwritten in a state in which policies are required to cover collision damage under property damage liability terms. |
endorsement-covers-rental-collision | pass | The policy is underwritten in a state in which policies are required to cover collision damage under an endorsement. |
coll-extends-to-rental-with-caution | caution | The policy has collision coverage, but the matching policy agreements have conflicting answers about whether collision coverage extends to rental vehicles. |
coll-extends-to-rental-with-unknown | unknown | The policy has collision coverage, but there is not enough information to determine if the policy extends collision coverage to rental vehicles. |
coll-does-not-extend-to-rental | fail | The policy has collision coverage, but the matching policy agreements indicate that collision coverage does not extend to rental vehicles. |
coll-not-present | fail | The policy does not have collision coverage, and therefore cannot extend collision coverage to rental vehicles. |
coll-presence-unknown | unknown | It is unknown if the policy has collision coverage, and therefore it is unknown if the policy extends collision coverage to rental vehicles. |
Auto
policies currently support policy validation testing, but we’ve also curated a special set of test policies specifically to provide options for testing the various outcomes of the rental-covered-for-collision
Rule.Enter the following credentials into an ignition session, and then select the policy labeled with the message code you would like to test. The message codes and their explanations are listed in the table above.Policy Expiration Date is After Provided Date
expiration-date-comparison
Status | Cause |
---|---|
pass | The policy’s expiration date is on or after the provided input date. |
fail | The policy’s expiration date is before the provided input date. |
unknown | The policy’s expiration date is null . |
input
must include a date
property as an ISO 8601 string, representing the date to compare against the policy’s expiration date.For example, valid input dates could be 2025-01-01
or 2025-01-01T00:00:00.000Z
. If an invalid date
is provided, this Rule will return a 400
response code.Collision Coverage Meets Requirements
collision-coverage-meets-requirements
vin
(optional): The Vehicle Identification Number to check for collision coverage specific to a vehicle.deductible
(optional): A specific collision deductible amount you want to verify against the policy.collision-coverage-meets-requirements
Rule to resolve to pass
.collision-exists
: Determines if collision coverage is present on the policy for any vehicle or, if a vin
is provided, for a specified vehicle.
collision-deductible-comparison
(optional): Verifies if the provided deductible
is less than or equal to the deductible specified in the collision coverage of the policy. This criteria will only run if collision-exists
results in a pass
and the optional deductible
is provided.
vin
is provided, the provided deductible
will be verified against all collision coverages listed on the policy.vin
is provided, the provided deductible
will be verified against only the collision coverage listed for the specified vehicle.Status | Cause |
---|---|
pass | The policy has collision coverage and meets all specified requirements (deductible and/or vin if provided) |
fail | The policy either lacks collision coverage or doesn’t meet the specified deductible requirements |
unknown | Not enough information was available to evaluate the coverage requirements |
pass
.Message Code | Evaluation Status | Message |
---|---|---|
coll-exists | pass | The COLL coverage exists on this policy. |
coll-exists-for-vin | pass | The COLL coverage exists on this policy for the specified vehicle. |
coll-valid-deductible | pass | The COLL coverage(s) on this policy have deductible(s) less than or equal to [inputDeductible]. |
coll-valid-deductible-for-vin | pass | The COLL coverage(s) on this policy for this specified vehicle have deductible(s) less than or equal to [inputDeductible]. |
coll-does-not-exist | fail | The COLL coverage does not exist on this policy. |
coll-does-not-exist-for-vin | fail | The COLL coverage does not exist on this policy for the specified vehicle. |
coll-invalid-deductible | fail | The COLL coverage(s) on this policy all have deductibles greater than [inputDeductible]. |
coll-invalid-deductible-for-vin | fail | The COLL coverage(s) on this policy for this specified vehicle all have deductibles greater than [inputDeductible]. |
coll-unknown-deductible | unknown | The COLL coverage(s) on this policy have unknown deductibles. |
coll-unknown-vin | unknown | The Axle Policy has incomplete property VIN data. Validation cannot be performed. |
vin
and that the deductible
for that coverage is less than or equal to $1,000.Comprehensive Coverage Meets Requirements
comprehensive-coverage-meets-requirements
vin
(optional): The Vehicle Identification Number to check for comprehensive coverage specific to a vehicle.deductible
(optional): A specific comprehensive deductible amount you want to verify against the policy.comprehensive-coverage-meets-requirements
Rule to resolve to pass
.comprehensive-exists
: Determines if comprehensive coverage is present on the policy for any vehicle or, if a vin
is provided, for a specified vehicle.
comprehensive-deductible-comparison
(optional): Verifies if the provided deductible
is less than or equal to the deductible specified in the comprehensive coverage of the policy. This criteria will only run if comprehensive-exists
results in a pass
and the optional deductible
is provided.
vin
is provided, the provided deductible
will be verified against all comprehensive coverages listed on the policy.vin
is provided, the provided deductible
will be verified against only the comprehensive coverage listed for the specified vehicle.Status | Cause |
---|---|
pass | The policy has comprehensive coverage and meets all specified requirements (deductible and/or vin if provided) |
fail | The policy either lacks comprehensive coverage or doesn’t meet the specified deductible requirements |
unknown | Not enough information was available to evaluate the coverage requirements |
pass
.Message Code | Evaluation Status | Message |
---|---|---|
comp-exists | pass | The COMP coverage exists on this policy. |
comp-exists-for-vin | pass | The COMP coverage exists on this policy for the specified vehicle. |
comp-valid-deductible | pass | The COMP coverage(s) on this policy have deductible(s) less than or equal to [inputDeductible]. |
comp-valid-deductible-for-vin | pass | The COMP coverage(s) on this policy for this specified vehicle have deductible(s) less than or equal to [inputDeductible]. |
comp-does-not-exist | fail | The COMP coverage does not exist on this policy. |
comp-does-not-exist-for-vin | fail | The COMP coverage does not exist on this policy for the specified vehicle. |
comp-invalid-deductible | fail | The COMP coverage(s) on this policy all have deductibles greater than [inputDeductible]. |
comp-invalid-deductible-for-vin | fail | The COMP coverage(s) on this policy for this specified vehicle all have deductibles greater than [inputDeductible]. |
comp-unknown-deductible | unknown | The COMP coverage(s) on this policy have unknown deductibles. |
comp-unknown-vin | unknown | The Axle Policy has incomplete property VIN data. Validation cannot be performed. |
vin
and that the deductible
for that coverage is less than or equal to $1,000.Bodily Injury Coverage Meets Requirements
bodily-injury-coverage-meets-requirements
limitPerAccident
(optional): The limitPerAccident amount you want to verify against the policy.limitPerPerson
(optional): The limitPerPerson amount you want to verify against the policy.bodily-injury-exists
: Determines if bodily injury coverage is present on the policy.
bodily-injury-limit-per-person-comparison
(if applicable): Determines if the limitPerPerson
specified on the policy’s bodily injury coverage is greater than or equal to the provided limitPerPerson
.
bodily-injury-limit-per-accident-comparison
(if applicable): Determines if the limitPerAccident
specified on the policy’s bodily injury coverage is greater than or equal to the provided limitPerAccident
.
Status | Cause |
---|---|
pass | The policy has bodily injury coverage and meets all specified limit requirements |
fail | The policy either lacks bodily injury coverage or doesn’t meet the specified limit requirements |
unknown | Not enough information was available to evaluate the coverage requirements |
pass
.Message Code | Evaluation Status | Message |
---|---|---|
bodily-injury-exists | pass | The BI coverage exists on this policy. |
bodily-injury-valid-limit-per-person | pass | The BI coverage on this policy has a limitPerPerson greater than or equal to [inputLimitPerPerson]. |
bodily-injury-valid-limit-per-accident | pass | The BI coverage on this policy has a limitPerAccident greater than or equal to [inputLimitPerAccident]. |
bodily-injury-valid-limits | pass | The BI coverage on this policy has limits greater than or equal to [inputLimitPerPerson] per person and [inputLimitPerAccident] per accident. |
bodily-injury-invalid-limit-per-person | fail | The BI coverage on this policy has a limitPerPerson less than to [inputLimitPerPerson]. |
bodily-injury-invalid-limit-per-accident | fail | The BI coverage on this policy has a limitPerAccident less than to [inputLimitPerAccident]. |
bodily-injury-invalid-limits | fail | The BI coverage on this policy has limits less than to [inputLimitPerPerson] per person and [inputLimitPerAccident] per accident. |
bodily-injury-unknown-limit-per-person | unknown | The BI coverage on this policy has a limitPerPerson that is unknown. |
bodily-injury-unknown-limit-per-accident | unknown | The BI coverage on this policy has a limitPerAccident that is unknown. |
bodily-injury-unknown-limits | unknown | The BI coverage on this policy has unknown limits. |
Uninsured/Underinsured Motorists Bodily Injury Coverage Meets Requirements
uninsured-underinsured-bi-coverage-meets-requirements
limitPerAccident
(optional): The limitPerAccident amount you want to verify against the policy.limitPerPerson
(optional): The limitPerPerson amount you want to verify against the policy.uninsured-underinsured-bi-exists
: Determines if UM, UIM, or UUIM motorists bodily injury coverage is present on the policy.
uninsured-underinsured-bi-limit-per-person-comparison
(if applicable): Determines if the limitPerPerson
on the policy’s UM, UIM, or UUIM bodily injury coverage is greater than or equal to the provided limitPerPerson
.
uninsured-underinsured-bi-limit-per-accident-comparison
(if applicable): Determines if the limitPerAccident
on the policy’s UM, UIM, or UUIM bodily injury coverage is greater than or equal to the provided limitPerAccident
.
Status | Cause |
---|---|
pass | The policy has at least one of UM, UIM, or UUIM bodily injury and meets all specified limit requirements |
fail | The policy either doesn’t have any UM, UIM, or UUIM bodily injury coverage, or has at least one but doesn’t meet the specified limit requirements. |
unknown | Not enough information was available to evaluate the coverage requirements. |
pass
.Message Code | Evaluation Status | Message |
---|---|---|
uninsured-underinsured-bi-exists | pass | At least one of UM, UIM, or UUIM bodily injury coverage exists on this policy. |
uninsured-underinsured-bi-valid-limit-per-person | pass | At least one of UM, UIM, or UUIM bodily injury coverage on this policy has a limitPerPerson greater than or equal to [inputLimitPerPerson]. |
uninsured-underinsured-bi-valid-limit-per-accident | pass | At least one of UM, UIM, or UUIM bodily injury coverage on this policy has a limitPerAccident greater than or equal to [inputLimitPerAccident]. |
uninsured-underinsured-bi-valid-limits | pass | At least one of UM, UIM, or UUIM bodily injury coverage on this policy has limits greater than or equal to [inputLimitPerPerson] per person and [inputLimitPerAccident] per accident. |
uninsured-underinsured-bi-invalid-limit-per-person | fail | None of UM, UIM, or UUIM bodily injury coverage on this policy has a limitPerPerson greater than or equal to [inputLimitPerPerson]. |
uninsured-underinsured-bi-invalid-limit-per-accident | fail | None of UM, UIM, or UUIM bodily injury coverage on this policy has a limitPerAccident greater than or equal to [inputLimitPerAccident]. |
uninsured-underinsured-bi-invalid-limits | fail | None of UM, UIM, or UUIM bodily injury coverage on this policy has limits greater than or equal to [inputLimitPerPerson] per person and [inputLimitPerAccident] per accident. |
uninsured-underinsured-bi-unknown-limit-per-person | unknown | At least one of UM, UIM, or UUIM bodily injury coverage on this policy has a limitPerPerson that is unknown. |
uninsured-underinsured-bi-unknown-limit-per-accident | unknown | At least one of UM, UIM, or UUIM bodily injury coverage on this policy has a limitPerAccident that is unknown. |
uninsured-underinsured-bi-unknown-limits | unknown | At least one of UM, UIM, or UUIM bodily injury coverage on this policy has unknown limits. |
Property Damage Coverage Meets Requirements
property-damage-coverage-meets-requirements
limitPerAccident
(optional): The limitPerAccident amount you want to verify against the policy.property-damage-exists
: Determines if property damage coverage is present on the policy.
property-damage-limit-per-accident-comparison
(if applicable): Determines if the limitPerAccident
specified on the policy’s property damage coverage is greater than or equal to the provided limitPerAccident
.
Status | Cause |
---|---|
pass | The policy has property damage coverage and meets all specified limit requirements. |
fail | The policy either lacks property damage coverage or doesn’t meet the specified limit requirements. |
unknown | Not enough information was available to evaluate the coverage requirements. |
pass
.Message Code | Evaluation Status | Message |
---|---|---|
property-damage-exists | pass | The PD coverage exists on this policy. |
property-damage-valid-limit-per-accident | pass | The PD coverage on this policy has a limitPerAccident greater than or equal to [inputLimitPerAccident]. |
property-damage-invalid-limit-per-accident | fail | The PD coverage on this policy has a limitPerAccident less than to [inputLimitPerAccident]. |
property-damage-unknown-limit-per-accident | unknown | The PD coverage on this policy has a limitPerAccident that is unknown. |
limitPerAccident
is greater than or equal to $50,000.Uninsured/Underinsured Motorists Property Damage Coverage Meets Requirements
uninsured-underinsured-pd-coverage-meets-requirements
limitPerAccident
(optional): The limitPerAccident amount you want to verify against the policy.uninsured-underinsured-pd-exists
: Determines if UM, UIM, or UUIM motorist property damage coverage is present on the policy.
uninsured-underinsured-pd-limit-per-accident-comparison
(if applicable): Determines if the limitPerAccident
on the policy’s UM, UIM, or UUIM property damage coverage is greater than or equal to the provided limitPerAccident
.
Status | Cause |
---|---|
pass | The policy has at least one of UM, UIM, or UUIM property damage coverage and meets all specified limit requirements. |
fail | The policy either doesn’t have any UM, UIM, or UUIM property damage coverage, or has at least one but doesn’t meet the specified limit requirements. |
unknown | Not enough information was available to evaluate the coverage requirements. |
pass
.Message Code | Evaluation Status | Message |
---|---|---|
uninsured-underinsured-pd-exists | pass | At least one of UM, UIM, or UUIM property damage coverage exists on this policy. |
uninsured-underinsured-pd-valid-limit-per-accident | pass | At least one of UM, UIM, or UUIM property damage coverage on this policy has a limitPerAccident greater than or equal to [inputLimitPerAccident]. |
uninsured-underinsured-pd-invalid-limit-per-accident | fail | None of UM, UIM, or UUIM property damage coverage on this policy has a limitPerAccident less than to [inputLimitPerAccident]. |
uninsured-underinsured-pd-unknown-limit-per-accident | unknown | At least one of UM, UIM, or UUIM property damage coverage on this policy has a limitPerAccident that is unknown. |
limitPerAccident
on the coverage is greater than or equal to $50,000.Insureds Match
insureds-match
Status | Cause |
---|---|
pass | All of the input insured names are listed on the Axle policy. |
caution | One or more of the input insured names passed a fuzzy match. This occurs when either the input name or Axle policy name is missing an additional first name or middle name (e.g. “John Tracy Smith” vs. “John Smith”). |
fail | One or more of the input insured names were not listed on the Axle policy. |
unknown | An error occurred during validation. |
insuredNames
: An array of full names provided as strings. Each name should be provided in the format "firstName middleName lastName suffix"
Address Match
address-match
Status | Cause |
---|---|
pass | Input address matches Axle Policy address |
caution | Input and Axle policy addressLine2 do not match |
fail | Input address does not match Axle Policy address |
unknown | There is insufficient information to compare input address and Axle Policy address. |
address
: Full address provided as a string
that includes both Address Line 1 and 2 along with city, postal code, and state.Properties Match
properties-match
vehicle
)policy.properties.type=vehicle
Status | Cause |
---|---|
pass | Exact match on the year and high similarity threshold score on make and model to one of the properties listed on the Axle Policy |
caution | Exact match on the year and medium similarity threshold score on make and model |
fail | No match on year or low similarity threshold score on make and model |
unknown | There is insufficient information to compare input yearMakeModel and Axle Policy |
yearMakeModel
: Provide a string in the following format “<year> <make model of the vehicle>”. For example, you can provide “2009 Honda Odyssey”vehicle
)policy.properties.type=vehicle
Status | Cause |
---|---|
pass | VIN matches a property listed on the Axle Policy |
fail | VIN doesn’t match any of the properties |
unknown | There is insufficient information to compare input VIN and Axle Policy |
vin
: Provide VIN number of the vehicle as a string
dwelling
)policy.properties.type=dwelling
Status | Cause |
---|---|
pass | Input address matches one of the properties on the Axle Policy |
caution | Input address may not match any of the properties because of a difference in addressLine2 |
fail | Input address does not match any of the properties |
unknown | There is insufficient information to compare input address and Axle Policy |
address
: Full address provided as a string
that includes both Address Line 1 and 2 along with city, postal code, and state.Third Parties Match
third-party-match
name
(required): String representing the name of the third party (e.g., “Major Bank”).address
(optional): String representing the address of the third party.Status | Cause |
---|---|
pass | Input name is a high-confidence match. If provided, address is also a high-confidence match. |
caution | Input name is a medium-confidence match OR, if provided, address is a medium confidence match. |
fail | Input name does not match or address does not match. |
unknown | There is insufficient information to compare the input third party details with those on the policy |
Required Policy Information is Present
required-policy-information-is-present
pass
. Otherwise, it resolves to fail
.This Rule combines two separate sub-rules:fields-exist
– Verifies that all fields specified by your requiredFields
input are present on the policy. If every requested field is found, this Rule resolves to pass
; otherwise, it resolves to fail
and includes a missingFields
list in the metadata.declarations-page-exists
– Checks whether the policy has at least one document classified by Axle as a declaration page.Status | Cause |
---|---|
pass | The policy has all required fields, or there is a declarations page (or both). |
fail | Neither the required fields nor a declarations page could be confirmed on the policy. |
requiredFields
: An object used to specify which fields must exist on the policy. Each key maps to a boolean (or nested object / array structure) indicating whether that particular field is required. The shape of the object mirrors the Axle Policy Schema.pass
.Vehicle Use Meets Requirements
vehicle-use-meets-requirements
vin
or yearMakeModel
is provided, the rule ensures that the matched vehicle has the expected use.use
(required): One of business
, commute
, or pleasure
.vin
(optional): The Vehicle Identification Number of the vehicle you want to check. If provided, the rule will only evaluate the vehicle with this VIN.yearMakeModel
(optional): Formatted string, e.g., "2020 Toyota Camry"
specifying which vehicle to check. If provided, the rule will only evaluate the vehicle that matches this yearMakeModel.Status | Cause |
---|---|
pass | At least one vehicle (or the specified vehicle) has the expected use. |
fail | All vehicles (or just the specified vehicle) fail to meet the usage requirement. |
unknown | Vehicle use data is not available or the specified vehicle is not found on the policy. |
Create or modify Validation Template
Provide dynamic inputs to Ignition metadata (optional)
Retrieve Validation Templates
Request Policy Validation with Template