Get Policy

Authorizations

x-client-secret

string

header

required

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 Exchange Token.

Path Parameters

string

required

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

Query Parameters

expand

enum<string>

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

Available options:

true,

false

Response

200 - application/json

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.

data.account

string

required

Unique identifier for the Account object associated with the Policy.

data.address

object

required

Primary address associated with the policy.

data.carrier

string

required

Insurance carrier that is the source for the Policy data.

data.coverages

object[]

required

List of coverage types and levels offered by the policy.

data.createdAt

string

required

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

data.documents

object[]

required

List of documents (such as declaration pages and policy agreements) associated with the policy.

data.effectiveDate

string | null

required

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

data.expirationDate

string | null

required

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

data.id

string

required

Unique identifier for the Policy object.

data.insureds

object[]

required

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

data.modifiedAt

string

required

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.

data.policyNumber

string | null

required

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

data.premium

number | null

required

Total policy premium, as specified by the insurance carrier. Note: only available for type=home,condo policies

data.properties

object[]

required

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

data.refreshedAt

string

required

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.

data.thirdParties

object[]

required

List of external parties with interest in the policy.

data.type

enum<string> | null

required

Type of insurance policy that the Policy object represents.

Available options:

auto,

motorcycle,

home,

condo

data.isActive

boolean | null

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.

success

boolean

Indicates whether the operation was performed successfully.

Home

Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response