The Policy object

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

Fields

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 floodRules applied:

auto includes non-owned auto insurance policies but does not include commercial or business auto insurance policies.
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).
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:

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.
isActive null indicates that the insurance carrier did not specify if the policy is active.

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.

Show Address

addressLine1

string or null

First line of the street address, typically including the house number and street name.

addressLine2

string or null

Additional address details, such as an apartment, suite, or unit number.

city

string or null

City name of the address.

state

string or null

State of the address.

postalCode

string or null

ZIP or postal code of the address.

country

string or null

Country of the address.

properties

array[Property]

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

Show Property

string

Unique identifier for the Property object.

type

string

The type of the insured property.Available options:vehicle - Represents a motor vehicle (e.g., car, truck, motorcycle, trailer) insured under the policy.dwelling - Refers to a residential property (e.g., house, apartment) insured under the policy.

data

Vehicle or Dwelling

Contains specific details related to the insured property.

Show Vehicle

vin

string

The Vehicle Identification Number (VIN), a unique code used to identify individual motor vehicles.

model

string or null

The specific model name of the vehicle, indicating the manufacturer’s designation.

year

string or null

The model year of the vehicle, representing the year it was manufactured.

make

string or null

The manufacturer or brand name of the vehicle.

use

string or null

The “vehicle use” or “primary use” of the vehicle, indicating how the vehicle is predominantly used by the insured. Note: This field is only available for select carriers.Available options:

pleasure - Includes cases when the vehicle use falls under multiple options, such as in “Pleasure/Commute” or “To Work, School or Pleasure”. This also includes use related to artisan and collector cars.
commute - Includes all vehicle use designations related to work (e.g. “Work 5-10”) as well as when mileage is specified (e.g. “10 Miles”)
business - Includes all designations related to business.
farm - Includes all designations related to farming.

bodyStyle

string or null (optional)

The style of the vehicle’s body (e.g., sedan, SUV, coupe), which describes its design and configuration.

Show Dwelling

addressLine1

string or null

The primary address line of the dwelling, typically including the street number and name.

addressLine2

string or null

An optional secondary address line for additional information (e.g., apartment number or suite).

city

string or null

The city where the dwelling is located.

state

string or null

The state where the dwelling is situated.

postalCode

string or null

The postal code for the dwelling’s address.

country

string or null

The country where the dwelling is located.

coverages

array[Coverage]

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

Show Coverage

code

string

required

A coverage code for the type of insurance coverage present. Each code corresponds to a human-readable label.Available options for an auto or motorcycle insurance policy:

BI - Bodily Injury
PD - Property Damage
UMBI - Uninsured Motorists Bodily Injury
UMPD - Uninsured Motorists Property Damage
UIMBI - Underinsured Motorists Bodily Injury
UIMPD - Underinsured Motorists Property Damage
UUIMBI - Uninsured & Underinsured Motorists Bodily Injury
UUIMPD - Uninsured & Underinsured Motorists Property Damage
COLL - Collision
COMP - Comprehensive

Available options for a home or condo insurance policy:

DW - Dwelling
OS - Other Structures
PP - Personal Property
LOU - Loss of Use
PL - Personal Liability
MED - Medical Expenses

label

string

required

A human-readable name describing the type of insurance coverage provided by the policy. The labels are provided above next to each corresponding coverage code.

limitPerPerson

number or null (optional)

The maximum amount the insurance policy will pay for bodily injury or damages sustained by an individual in a covered incident.

limitPerAccident

number or null (optional)

The maximum amount the insurance policy will pay for a single accident or claim.

deductible

number or null (optional)

The amount the policyholder must pay out-of-pocket toward a claim before the insurance coverage begins to pay.

property

string or null (optional)

Unique identifier of Property afforded coverage. If specified coverage is afforded to all properties on the policy, property will be undefined.

Within a Policy object, there will only be a single Coverage object per coverage code per property.

insured

array[Insured]

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

Excluded drivers are removed from Insureds list for auto and motorcycle insurance policies.
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”.

Show Insured

firstName

string or null

The first name of the insured individual.

lastName

string or null

The last name of the insured individual.

Insurance carriers may represent firstName and lastName in different ways (such as including middle name in firstName or dropping special characters such as -).If your application requires matching your users against policy insureds, it is recommended to combine firstName and lastName into a single value and using a “fuzzy” matching algorithm with a strict threshold.

type

string or null

The role of the insured individual, indicating whether they are the primary policyholder / user or a secondary insured party. Note: this field is in continued development and is subject to modification. Should be used for display purposes only.Available options:primary - The policyholder or primary user of the insured property.secondary - An additional person insured under the policy, such as an additional driver.If the role of the Insured is not specified, type will be null.

dateOfBirthYear

string or null

The birth year of the insured individual. Note: This field is only available for select carriers.

licenseNo

string or null

The driver’s license number of the insured individual. Note: This field is only available for select carriers.

licenseState

string or null

The state that issued the insured individual’s driver’s license. Note: This field is only available for select carriers.

dateOfBirth

string or null

The insured individual’s date of birth in a standard date format. Note: This field is only available for select carriers.

property

string or null (optional)

Unique identifier of Property afforded coverage for specified Insured. If Insured is afforded coverage across all properties on the policy, property will be undefined.

thirdParties

array[ThirdParty]

List of external parties with interest in the policy.

Show ThirdParty

type

string or null

The role of the Third Party associated with the insured property. Note: this field is in continued development and is subject to modification. Should be used for display purposes only.The Axle Schema currently supports the following Third Party options. See below for details on Axle’s standardization of Third Party type based on data provided by the insurance carrier.Available options:lienholder - A financial institution or individual that holds a legal claim on the insured property. This includes mortgagees.lessor - The owner or leasing company that leases the insured property to the policyholder under a lease agreement. This includes loss payees if the Third Party is also assessed as an Additional Insured.interest - Any Third Party with a financial interest in the insured property. This option serves as the conservative default used in the following cases:

The Third Party is specifically listed as an “additional interest”.
The Third Party falls across options (e.g. a Third Party that is both an additional insured and an additional interest).

If the role of the Third Party is not specified, type will be null.

name

string

The name of the Third Party.

address

Address

The address of the Third Party. Note: This field may not be available for all carriers.

property

string or null

Unique identifier of Property for which the specified Third Party is afforded coverage through this 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:

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

Show Document

string

Unique identifier (formatted as filename) for the document.

source

string

The origin of the document.Available options:carrier - Indicates that the document originated from the insurance carrier.user - Indicates that the document was uploaded by the user.

User-provided documents are not verified by Axle.

name

string

The name of the document.

type

array[string]

The type of information contained in the document, as specified by carrier or user. A document may have multiple types.Available options:declaration-page - A summary document that outlines the key details of the insurance policy, including coverage limits, premiums, and insured parties. This includes renewal policy documents, amended policy documents, and new business documents.policy-agreement - The formal contract between the insurer and the policyholder that specifies the terms and conditions of the insurance coverage. This includes insurance policy contract documents. Note that this type of document may not always be available.id-card - An identification card issued by the insurer that serves as proof of insurance coverage and includes relevant policy information for the insured vehicle. This document type is generally only found for auto insurance policies.

url

string

Pre-signed url to access document.

For security, document urls have an expiry of 60 minutes.

issuedDate

string or null

If available, ISO 8601 timestamp at which the document was generated or issued by the carrier.

effectiveDate

string or null

If available, ISO 8601 timestamp at which the document becomes active or goes into effect.

createdAt

string

ISO 8601 timestamp at which the document was fetched or shared via Axle.

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.

{
  "id": "pol_CbxGmGWnp9bGAFCC-eod2",
  "account": "acc_gM2wn_gaqUv76ZljeVXOv",
  "type": "auto",
  "carrier": "state-farm",
  "policyNumber": "123456789",
  "isActive": true,
  "effectiveDate": "2021-10-22T04:00:00.000Z",
  "expirationDate": "2022-10-22T04:00:00.000Z",
  "premium": null,
  "address": {
    "addressLine1": "123 Main St.",
    "addressLine2": "Unit 456",
    "city": "Atlanta",
    "state": "Georgia",
    "postalCode": "30315",
    "country": "USA"
  },
  "properties": [
    {
      "id": "prp_uSdzLVpi8c76H7kl6AQ-F",
      "type": "vehicle",
      "data": {
        "bodyStyle": "sedan",
        "vin": "WDDWJ8EB4KF776265",
        "model": "C 300",
        "year": "2019",
        "make": "Mercedes-Benz",
        "use": "commute"
      }
    },
    {
      "id": "prp_tmGUxLpgHjmW9r6M6WjhS",
      "type": "vehicle",
      "data": {
        "bodyStyle": "minivan",
        "vin": "5FNRL38209B014050",
        "model": "Odyssey",
        "year": "2009",
        "make": "Honda",
        "use": "pleasure"
      }
    }
  ],
  "coverages": [
    { 
      "code": "BI",
      "label": "Bodily Injury",
      "limitPerPerson": 250000,
      "limitPerAccident": 500000
    },
    {
      "code": "PD",
      "label": "Property Damage",
      "limitPerAccident": 100000
    },
    {
      "code": "UMBI",
      "label": "Uninsured Bodily Injury",
      "limitPerPerson": 100000,
      "limitPerAccident": 300000, 
    },
    {
      "code": "COMP",
      "label": "Comprehensive",
      "deductible": 375,
      "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
    },
    {
      "code": "COLL",
      "label": "Collision",
      "deductible": 375,
      "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
    }
  ],
  "insureds": [
    {
      "type": "primary",
      "firstName": "John",
      "lastName": "Smith",
      "dateOfBirthYear": "1990",
      "licenseNo": "•••••1234",
    },
    {
      "type": "primary",
      "firstName": "Jane",
      "lastName": "Doe",
      "dateOfBirthYear": "1992",
      "licenseNo": "•••••5678",
    }
  ],
  "thirdParties": [
    {
      "property": "prp_tmGUxLpgHjmW9r6M6WjhS",
      "type": "lessor",
      "name": "Super Leasing Trust",
      "address": {
        "addressLine1": "PO Box 123456",
        "country": null,
        "addressLine2": null,
        "state": "GA",
        "city": "Atlanta",
        "postalCode": "30348-5245"
      }
    },
  ],
  "documents": [
    {
      "id": "doc_jd73dw6fn02sj28.pdf",
      "source": "carrier",
      "name": "Declaration Page",
      "type": ["declaration-page"],
      "url": "<signed-url>",
      "issuedDate": "2022-01-01T00:00:00.000Z",
      "effectiveDate": "2022-01-02T00:00:00.000Z",
      "createdAt": "2022-01-01T00:00:00.000Z"
    }
  ],
  "createdAt": "2022-01-01T00:00:00.000Z",
  "modifiedAt": "2022-01-01T00:00:00.000Z",
  "refreshedAt": "2022-01-01T00:00:00.000Z"
}

Home

Guides

API Reference

Advanced

The Policy object

Fields

Home

Guides

API Reference

Advanced

​Fields

Fields