Get Policy
The Get Policy method returns a Policy object including high-level policy information (e.g., policy number) and any children objects (e.g., Coverages) associated with the Policy. Please note that this method will NOT refresh the Policy object.
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.
Your client ID. This will be shared with you during onboarding.
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.
The access token required for access to the requested Account. Returned as part of the Token Exchange flow in exchangeToken.
The unique ID for the requested policy. Returned by Get Account for each Policy associated with the Account.
Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.
curl --request GET \
--url https://api.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
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
Your client ID. This will be shared with you during onboarding.
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.
The access token required for access to the requested Account. Returned as part of the Token Exchange flow in exchangeToken.
Path Parameters
The unique ID for the requested policy. Returned by Get Account for each Policy associated with the Account.
Query Parameters
Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.
Response
Indicates whether the operation was performed successfully.
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.
Unique identifier for the Policy object.
Unique identifier for the Account object associated with the Policy.
Type of insurance policy that the Policy object represents.
auto, motorcycle, home Insurance carrier that is the source for the Policy data.
Identifier of the policy, as specified by the insurance carrier.
Active status of the policy, as specified by the insurance carrier.
ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier.
ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.
Total policy premium, as specified by the insurance carrier. Note: only available for type=home policies
Primary address associated with the policy.
List of coverage types and levels offered by the policy.
BI, PD, UMBI, UMPD, UIMBI, UIMPD, UUIMBI, UUIMPD, COLL, COMP Unique identifier of Property afforded coverage. If specified coverage is afforded to all properties on the policy, property will be undefined.
List of properties (such as a vehicle or dwelling) afforded coverage by the policy.
vehicle, dwelling List of entities (such as an individuals or businesses) afforded direct coverage by the policy.
Should be used for display purposes only. All listed insureds are afforded coverage by the policy.
primary, secondary Unique identifier of Property afforded coverage for specified Insured. If Insured is afforded coverage across all properties on the policy, property will be undefined.
List of external parties with interest in the policy.
Should be used for display purposes only. All listed thirdParties have established financial interest in the associated property.
lienholder, lessor, interest List of documents (such as declaration pages and policy agreements) associated with the policy.
The source of the document. Note, user documents are unverified by Axle.
carrier, user Name of the document, as specified by carrier or user.
The type of information contained in the document, as specified by carrier or user. A document may have multiple types.
declaration-page, id-card, policy-agreement URL for document access. Note, the URL is signed and has an expiry of 10 minutes.
ISO 8601 timestamp at which the document was fetched or shared via Axle.
ISO 8601 timestamp at which the Policy object was generated via Axle.
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.
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.
curl --request GET \
--url https://api.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"
}
}