GET
/
policies
/
{id}
curl --request GET \
  --url https://sandbox.axle.insure/policies/{id} \
  --header 'x-access-token: <x-access-token>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <api-key>'
{
  "success": true,
  "data": {
    "id": "pol_CbxGmGWnp9bGAFCC-eod2",
    "account": "acc_gM2wn_gaqUv76ZljeVXOv",
    "type": "auto",
    "carrier": "state-farm",
    "policyNumber": "123456789",
    "isActive": true,
    "effectiveDate": "2022-10-22T04:00:00.000Z",
    "expirationDate": "2023-10-22T04:00:00.000Z",
    "premium": 999.99,
    "address": {
      "addressLine1": "123 Fake St.",
      "addressLine2": "Unit 456",
      "city": "Atlanta",
      "state": "Georgia",
      "postalCode": "30315",
      "country": "USA"
    },
    "coverages": [
      {
        "code": "BI",
        "label": "Bodily Injury",
        "limitPerPerson": 250000,
        "limitPerAccident": 500000,
        "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
      },
      {
        "code": "PD",
        "label": "Property Damage",
        "limitPerAccident": 100000,
        "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
      },
      {
        "code": "COMP",
        "label": "Comprehensive",
        "deductible": 375,
        "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
      },
      {
        "code": "COLL",
        "label": "Collision",
        "deductible": 375,
        "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
      },
      {
        "code": "UMBI",
        "label": "Uninsured Bodily Injury",
        "limitPerPerson": 100000,
        "limitPerAccident": 300000,
        "property": "prp_uSdzLVpi8c76H7kl6AQ-F"
      }
    ],
    "properties": [
      {
        "id": "prp_uSdzLVpi8c76H7kl6AQ-F",
        "type": "vehicle",
        "data": {
          "vin": "SMTD44GN3HT812287",
          "model": "CR-V",
          "year": "2017",
          "make": "HONDA"
        }
      }
    ],
    "insureds": [
      {
        "firstName": "Armaan",
        "lastName": "Sikand",
        "dateOfBirthYear": "1993",
        "licenseNo": "•••••7259",
        "licenseState": "GA",
        "dateOfBirth": null,
        "type": "primary"
      }
    ],
    "thirdParties": [
      {
        "name": "Super Leasing Trust",
        "type": "lessor",
        "address": {
          "addressLine1": "Po Box 105205",
          "state": "GA",
          "city": "Atlanta",
          "postalCode": "30348-5205"
        }
      }
    ],
    "documents": [
      {
        "source": "carrier",
        "name": "Declaration Page",
        "type": [
          "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"
  }
}

Authorizations

x-client-secret
string
headerrequired

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.

Headers

x-client-id
string
required

Your client ID. This will be shared with you during onboarding.

x-destination-client-id
string

The client ID of the destination client. This is optional and only used by platform clients. See the Axle for Platforms guide for more information.

x-access-token
string
required

The access token required for access to the requested Account. Returned as part of the Token Exchange flow in exchangeToken.

Path Parameters

id
string
required

The unique ID for the requested policy. Returned by Get Account for each Policy associated with the Account.

Query Parameters

expand
boolean

Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.

Response

200 - application/json
success
boolean

Indicates whether the operation was performed successfully.

data
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.