The Policy object
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.
All fields are nullable and required unless otherwise specified. See API overview for more details.
Fields
Unique identifier for the Policy object.
Unique identifier for the Account object associated with the Policy.
Type of insurance policy that the Policy object represents. Available options:
auto
motorcycle
home
condo
Insurance carrier that is the source for the Policy data.
Identifier of the policy, as specified by the insurance carrier.
Active status of the policy, as specified by the insurance carrier. If an
Ignition session is completed with result: manual
, this field will be
undefined.
ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier.
ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.
Total policy premium, as specified by the insurance carrier. Note: only
available for type=home
policies
Primary address associated with the policy.
List of properties (such as a vehicle or dwelling) afforded coverage by the policy.
List of coverage types and levels offered by the policy.
List of entities (such as an individuals or businesses) afforded direct coverage by the policy.
List of external parties with interest in the policy.
List of documents (such as declaration pages and policy agreements) associated with the policy.
ISO 8601 timestamp at which the Policy object was generated via Axle.
ISO 8601 timestamp at which the Policy object was modified via Axle. The Policy object is modified only when there are differences between the current Policy and new Policy data requested from the carrier.
ISO 8601 timestamp at which the Policy object was refreshed via Axle. The Policy object is refreshed only when Axle successfully requests new Policy data from the carrier.
If the refreshedAt
date does not update daily, we’re working on re-establishing the connection with the
insurance carrier to retrieve updated policy data. Please keep an eye on the refreshedAt
and connection
fields to
confirm they’re active and up-to-date.