Axle home pagelight logo
Policies
The Policy object

All fields are nullable and required unless otherwise specified. See API overview for more details.

​
Attributes


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

carrier
string

Insurance carrier that is the source for the Policy data.

policyNumber
string

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

isActive
boolean

Active status of the policy, as specified by the insurance carrier.

effectiveDate
string

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

expirationDate
string

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

address
Address
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.

insured
array[Insured]

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

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.

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.

{
  "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",
  "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"
      }
    },
    {
      "id": "prp_tmGUxLpgHjmW9r6M6WjhS",
      "type": "vehicle",
      "data": {
        "bodyStyle": "minivan",
        "vin": "5FNRL38209B014050",
        "model": "Odyssey",
        "year": "2009",
        "make": "Honda"
      }
    }
  ],
  "coverages": [
    { 
      "code": "BI",
      "label": "Bodily Injury Liability",
      "limitPerPerson": 250000,
      "limitPerAccident": 500000
    },
    {
      "code": "PD",
      "label": "Property Damage Liability",
      "limitPerAccident": 100000
    },
    {
      "code": "UMBI",
      "label": "Uninsured Bodily Injury Liability",
      "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",
      "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
    },
    {
      "type": "secondary",
      "firstName": "Jane",
      "lastName": "Doe",
      "dateOfBirthYear": "1992",
      "licenseNo": "•••••5678",
      "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
    },
    {
      "type": "primary",
      "firstName": "Jane",
      "lastName": "Doe",
      "dateOfBirthYear": "1992",
      "licenseNo": "•••••5678",
      "property": "prp_tmGUxLpgHjmW9r6M6WjhS"
    }
  ],
  "thirdParties": [
    {
      "property": "prp_uSdzLVpi8c76H7kl6AQ-F",
      "type": "lienholder",
      "name": "Super Credit Union",
      "address": {
        "addressLine1": "PO Box 123456",
        "country": null,
        "addressLine2": null,
        "state": "GA",
        "city": "Atlanta",
        "postalCode": "30348-5245"
      }
    },
    {
      "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": [
    {
      "source": "carrier"
      "name": "Declaration Page"
      "url": "<signed-url>"
      "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"
}