All fields are nullable when not available and present unless otherwise specified. See API overview for more details.

Fields


id
string

Unique identifier for the Policy object.

account
string

Unique identifier for the Account object associated with the Policy.

type
string

Type of insurance policy that the Policy object represents.

Available options:

auto motorcycle home condo

Rules applied:

  1. auto includes non-owned auto insurance policies but does not include commercial or business auto insurance policies.
  2. home includes HO-1, HO-2, HO-3, HO-5, HO-7, and HO-8 homeowners insurance policies. It also includes landlord and specialty fire policies. It does not include HO-4 (i.e. renter’s policies).
  3. condo is equivalent to an HO-6 insurance policy.
carrier
string

Insurance carrier that is the source for the Policy data.

policyNumber
string or null

Identifier of the policy, as specified by the insurance carrier.

isActive
boolean or null (optional)

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.

Rules applied:

  1. isActive true includes policies that are specified as active but may also include policies in pre-effective or pending cancellation statuses that are marked as active by the carrier.
effectiveDate
string or null

ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier. The effective date may be in the future for policies that renew early.

expirationDate
string or null

ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.

premium
number or null

Policy term premium, as specified by the insurance carrier. This value is inclusive of discounts and fees but may exclude certain fees due to variation in carrier reporting or additional surcharges placed via state policies.

address
Address

Primary address associated with the policy.

properties
array[Property]

List of properties (such as a vehicle or dwelling) afforded coverage by the policy.

coverages
array[Coverage]

List of coverage types and levels offered by the policy. Refer to Coverages for additional detail about the supported coverage types.

insured
array[Insured]

List of entities (such as an individuals or businesses) afforded direct coverage by the policy.

Rules applied:

  1. Excluded drivers are removed from Insureds list for auto and motorcycle insurance policies.
  2. Entities listed as Additional Insureds are not included within the list of Insureds but are included under the list of Third Parties as an “interest”.
thirdParties
array[ThirdParty]

List of external parties with interest in the policy.

documents
array[Document]

List of documents (such as declaration pages and policy agreements) associated with the policy. Note that the insurance carrier may not always update documents on the policy to reflect policy changes or term renewals.

Rules applied:

  1. Only the most recently effective or issued document of each document type will be present in the document list.
  2. There will only be at most one document of each type listed in the documents list.
createdAt
string

ISO 8601 timestamp at which the Policy object was generated via Axle.

modifiedAt
string

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.

refreshedAt
string

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.