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, thepolicy-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 |
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 eitherpass
, 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 offail
.caution
means that one or more specified Rules evaluated to a status ofcaution
. 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.
Supported Rules
The Axle team is actively working on adding additional supported Rules. Please
reach out with any suggestions!
Policy is Active
Policy is Active
policy-active
Evaluates whether the policy is currently 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 |
Example Rule
Rental Vehicle is Covered For Collision Damage
Rental Vehicle is Covered For Collision Damage
rental-covered-for-collision
Evaluates the likelihood that the policy provides coverage for collision damage when an insured is driving a rental vehicle, based on the collision coverage available on the policy and the policy terms of insurance agreements similar to the one used by this policy.There are three ways that a user’s auto insurance policy may cover collision damage to a rental vehicle.- Their policy includes collision coverage and personal collision coverage extends to a rental vehicle.
- Their policy is registered in a state in which policies are required to cover collision damage to a rental vehicle under property damage liability terms.
- Their policy is registered in a state in which policies are required to cover collision damage to a rental vehicle under an endorsement.
rental-covered-for-collision
Rule resolves to pass
.Rental Coverage Validation AI
In order to determine if a policy meets these criteria, Axle’s Validation AI matches the auto policy to a repository of up-to-date policy agreements (also known as forms) as well as any relevant state regulations, and then synthesizes these resources into a recommendation.The
rental-covered-for-collision
recommendation may not apply the following scenarios:- long term rentals (greater than 30 days)
- rental of medium or heavy duty vehicles (above 10,000 lbs)
- use of temporary substitute vehicles (such as replacement or loaner vehicle)
- use of rental vehicle for TNC, DNC, or other auto business
- rentals outside of the continental United States
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. |
Example Rule
Testing in Sandbox
All sandboxAuto
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
Policy Expiration Date is After Provided Date
expiration-date-comparison
Given an input date, evaluates whether the policy’s expiration date is greater than or equal to (on or after) the input date.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.- The policy’s expiration date.
- The input date that was provided.
Collision Coverage Meets Requirements
Collision Coverage Meets Requirements
collision-coverage-meets-requirements
Evaluates whether the policy has collision coverage and if the coverage meets specific deductible requirements. This rule can evaluate coverage requirements for a specific vehicle (using VIN) or for the entire policy.Input Parametersvin
(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 avin
is provided, for a specified vehicle. -
collision-deductible-comparison
(optional): Verifies if the provideddeductible
is less than or equal to the deductible specified in the collision coverage of the policy. This criteria will only run ifcollision-exists
results in apass
and the optionaldeductible
is provided.- If no
vin
is provided, the provideddeductible
will be verified against all collision coverages listed on the policy. - If a
vin
is provided, the provideddeductible
will be verified against only the collision coverage listed for the specified vehicle.
- If no
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.Example Rule Request
Example Rule Response
Comprehensive Coverage Meets Requirements
Comprehensive Coverage Meets Requirements
comprehensive-coverage-meets-requirements
Evaluates whether the policy has comprehensive coverage and if the coverage meets specific deductible requirements. This rule can evaluate coverage requirements for a specific vehicle (using VIN) or for the entire policy.Input Parametersvin
(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 avin
is provided, for a specified vehicle. -
comprehensive-deductible-comparison
(optional): Verifies if the provideddeductible
is less than or equal to the deductible specified in the comprehensive coverage of the policy. This criteria will only run ifcomprehensive-exists
results in apass
and the optionaldeductible
is provided.
- If no
vin
is provided, the provideddeductible
will be verified against all comprehensive coverages listed on the policy. - If a
vin
is provided, the provideddeductible
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.Example Rule Request
Example Rule Response
Bodily Injury Coverage Meets Requirements
Bodily Injury Coverage Meets Requirements
bodily-injury-coverage-meets-requirements
Evaluates whether the policy has bodily injury coverage and if the coverage meets specific limit requirements.Input ParameterslimitPerAccident
(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 thelimitPerPerson
specified on the policy’s bodily injury coverage is greater than or equal to the providedlimitPerPerson
. -
bodily-injury-limit-per-accident-comparison
(if applicable): Determines if thelimitPerAccident
specified on the policy’s bodily injury coverage is greater than or equal to the providedlimitPerAccident
.
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. |
Example Rule Request
Example Rule Response
Uninsured/Underinsured Motorists Bodily Injury Coverage Meets Requirements
Uninsured/Underinsured Motorists Bodily Injury Coverage Meets Requirements
uninsured-underinsured-bi-coverage-meets-requirements
Evaluates whether a policy includes uninsured motorists (UM), underinsured motorists (UIM), or uninsured/underinsured motorists (UUIM) bodily injury coverage and verifies if the coverage(s) meet the specified limit requirements.Input ParameterslimitPerAccident
(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 thelimitPerPerson
on the policy’s UM, UIM, or UUIM bodily injury coverage is greater than or equal to the providedlimitPerPerson
. -
uninsured-underinsured-bi-limit-per-accident-comparison
(if applicable): Determines if thelimitPerAccident
on the policy’s UM, UIM, or UUIM bodily injury coverage is greater than or equal to the providedlimitPerAccident
.
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. |
Example Rule Request
Example Rule Response
Property Damage Coverage Meets Requirements
Property Damage Coverage Meets Requirements
property-damage-coverage-meets-requirements
Evaluates whether the policy has property damage coverage and if the coverage meets specific limit requirements.Input ParameterslimitPerAccident
(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 thelimitPerAccident
specified on the policy’s property damage coverage is greater than or equal to the providedlimitPerAccident
.
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.Example Rule Request
Example Rule Response
Uninsured/Underinsured Motorists Property Damage Coverage Meets Requirements
Uninsured/Underinsured Motorists Property Damage Coverage Meets Requirements
uninsured-underinsured-pd-coverage-meets-requirements
Evaluates whether a policy includes uninsured motorist (UM), underinsured motorist (UIM), or uninsured/underinsured motorist (UUIM) property damage coverage and verifies if the coverage(s) meet the specified limit requirements.Input ParameterslimitPerAccident
(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 thelimitPerAccident
on the policy’s UM, UIM, or UUIM property damage coverage is greater than or equal to the providedlimitPerAccident
.
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.Example Rule Request
Example Rule Response
Insureds Match
Insureds Match
insureds-match
Evaluates whether all of the input insured names are listed on the Axle policy.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"
This Rule currently does not support nickname matching. Please contact the Axle team if this is a feature of interest.Additionally, it is unlikely that insureds across households will be present on a single insurance policy. Please ensure that the input only contains insured names you expect to be on the policy.
Example Rule Request
Example Rule Response
Address Match
Address Match
address-match
Evaluates whether input address matches the address that is listed on the Axle policy.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 astring
that includes both Address Line 1 and 2 along with city, postal code, and state.
Example Rule Request
Example Rule Response
Properties Match
Properties Match
properties-match
Evaluates whether input property matches the property that is listed on Axle Policy. Properties can be matched via yearMakeModel, VIN, or address (corresponding to type of property).yearMakeModel (property type vehicle
)
Evaluates if provided yearMakeModel matches yearMakeModel listed as one of the properties when 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”
Example Rule Request
Example Rule Response
vin (property type vehicle
)
Evaluates if provided VIN matches the VIN listed as one of the properties when 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 astring
Example Rule Request
Example Rule Response
Address (property type dwelling
)
Evaluates if provided address matches the address listed as one of the properties when 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 astring
that includes both Address Line 1 and 2 along with city, postal code, and state.
Example Rule Request
Example Rule Response
Third Parties Match
Third Parties Match
third-party-match
Evaluates whether a third party listed on the policy matches the provided name and, if provided, the third party’s address.Input Parameters
name
(required): String representing the name of the third party (e.g., “Major Bank”).address
(optional): String representing the address of the third party.
Responses
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 |
Example Usage
Example Rule Request
Example Rule Response
Required Policy Information is Present
Required Policy Information is Present
required-policy-information-is-present
Evaluates if the policy either has (1) certain required fields present OR (2) at least one declarations page. If either sub-rule passes, the overall Rule resolves to pass
. Otherwise, it resolves to fail
.This Rule combines two separate sub-rules:fields-exist
– Verifies that all fields specified by yourrequiredFields
input are present on the policy. If every requested field is found, this Rule resolves topass
; otherwise, it resolves tofail
and includes amissingFields
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
.Example Rule Request
Example Rule Response
Vehicle Use Meets Requirements
Vehicle Use Meets Requirements
vehicle-use-meets-requirements
Evaluates whether any vehicle on the policy has a specified use (e.g., business, commute, or pleasure). If a vin
or yearMakeModel
is provided, the rule ensures that the matched vehicle has the expected use.Input Parameters
use
(required): One ofbusiness
,commute
, orpleasure
.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.
Responses
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. |
Example Usage
Example Rule Request
Example Rule Response
Policy Created Via Credit Card Form
Policy Created Via Credit Card Form
policy-created-via-credit-card
Evaluates whether the policy was created via Axle’s credit card submission flow.This Rule does not require any input.Status | Cause |
---|---|
pass | The policy is a credit card policy |
fail | The policy is not a credit card policy |
Example Rule Request
Example Rule Response
Policy Refreshed Within Days
Policy Refreshed Within Days
refreshed-within-days
Evaluates whether the policy has been refreshed within the last N days (relative to the current time the validation is executed).Input Parameters
days
(required): A non‑negative number representing how many days back from “now” to consider acceptable. If the policy’srefreshedAt
timestamp is on or after the computed threshold (more recent thandays
days ago), the Rule resolves topass
; otherwise it resolves tofail
.
Responses
Status | Cause |
---|---|
pass | policy.refreshedAt is within (>=) the last days days. |
fail | policy.refreshedAt is older than the last days days. |
caution
or unknown
outcomes.Metadata Returned
refreshedAt
: The policy’srefreshedAt
timestamp.input.days
: The input number of days used for comparison.thresholdDate
: The ISO timestamp representing the earliest acceptable refresh time (now - days
).
Example Usage
Example Rule Request
Example Rule Response