Get Policy
/policies/{id}
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: <x-client-secret>'
{
"data": {
"account": "acc_gM2wn_gaqUv76ZljeVXOv",
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"country": "USA",
"postalCode": "30315",
"state": "Georgia"
},
"carrier": "state-farm",
"coverages": [
{
"code": "BI",
"label": "Bodily Injury Liability",
"limitPerAccident": 500000,
"limitPerPerson": 250000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "PD",
"label": "Property Damage Liability",
"limitPerAccident": 100000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "UMBI",
"label": "Uninsured Bodily Injury Liability",
"limitPerAccident": 300000,
"limitPerPerson": 100000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "COMP",
"deductible": 375,
"label": "Comprehensive",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "COLL",
"deductible": 375,
"label": "Collision",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "BI",
"label": "Bodily Injury Liability",
"limitPerAccident": 500000,
"limitPerPerson": 250000,
"property": "prp_tmGUxLpgHjmW9r6M6WjhS"
},
{
"code": "PD",
"label": "Property Damage Liability",
"limitPerAccident": 100000,
"property": "prp_tmGUxLpgHjmW9r6M6WjhS"
},
{
"code": "UMBI",
"label": "Uninsured Bodily Injury Liability",
"limitPerAccident": 300000,
"limitPerPerson": 100000,
"property": "prp_tmGUxLpgHjmW9r6M6WjhS"
}
],
"createdAt": "2022-01-01T00:00:00.000Z",
"documents": [
{
"createdAt": "2022-01-01T00:00:00.000Z",
"name": "Declaration Page",
"source": "carrier",
"url": "<signed-url>"
}
],
"effectiveDate": "2021-10-22T04:00:00.000Z",
"expirationDate": "2022-10-22T04:00:00.000Z",
"id": "pol_CbxGmGWnp9bGAFCC-eod2",
"insureds": [
{
"dateOfBirthYear": "1990",
"firstName": "John",
"lastName": "Smith",
"licenseNo": "•••••1234",
"licenseState": "GA",
"licenseStatus": "Valid",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "Primary"
},
{
"dateOfBirthYear": "1992",
"firstName": "Jane",
"lastName": "Doe",
"licenseNo": "•••••5678",
"licenseState": "GA",
"licenseStatus": "Valid",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "Secondary"
},
{
"dateOfBirthYear": "1992",
"firstName": "Jane",
"lastName": "Doe",
"licenseNo": "•••••5678",
"licenseState": "GA",
"licenseStatus": "Valid",
"property": "prp_tmGUxLpgHjmW9r6M6WjhS",
"type": "Primary"
}
],
"isActive": true,
"modifiedAt": "2022-01-01T00:00:00.000Z",
"policyNumber": "123456789",
"properties": [
{
"data": {
"bodyStyle": "sedan",
"make": "Mercedes-Benz",
"model": "C 300",
"vin": "WDDWJ8EB4KF776265",
"year": "2019"
},
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle"
},
{
"data": {
"bodyStyle": "minivan",
"make": "Honda",
"model": "Odyssey",
"vin": "5FNRL38209B014050",
"year": "2009"
},
"id": "prp_tmGUxLpgHjmW9r6M6WjhS",
"type": "vehicle"
}
],
"refreshedAt": "2022-01-01T00:00:00.000Z",
"thirdParties": [
{
"address": {
"addressLine1": "PO Box 123456",
"addressLine2": null,
"city": "Atlanta",
"country": null,
"postalCode": "30348-5245",
"state": "GA"
},
"name": "Super Credit Union",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "lienholder"
},
{
"address": {
"addressLine1": "PO Box 123456",
"addressLine2": null,
"city": "Atlanta",
"country": null,
"postalCode": "30348-5245",
"state": "GA"
},
"name": "Super Leasing Trust",
"property": "prp_tmGUxLpgHjmW9r6M6WjhS",
"type": "lessor"
}
],
"type": "auto"
},
"success": "boolean"
}
Headers
Your client ID. This will be shared with you during onboarding.
Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!
The access token required for access to the requested user’s 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). Defaults to false.
Response
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.
Indicates whether the operation was performed successfully.
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: <x-client-secret>'
{
"data": {
"account": "acc_gM2wn_gaqUv76ZljeVXOv",
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"country": "USA",
"postalCode": "30315",
"state": "Georgia"
},
"carrier": "state-farm",
"coverages": [
{
"code": "BI",
"label": "Bodily Injury Liability",
"limitPerAccident": 500000,
"limitPerPerson": 250000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "PD",
"label": "Property Damage Liability",
"limitPerAccident": 100000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "UMBI",
"label": "Uninsured Bodily Injury Liability",
"limitPerAccident": 300000,
"limitPerPerson": 100000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "COMP",
"deductible": 375,
"label": "Comprehensive",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "COLL",
"deductible": 375,
"label": "Collision",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "BI",
"label": "Bodily Injury Liability",
"limitPerAccident": 500000,
"limitPerPerson": 250000,
"property": "prp_tmGUxLpgHjmW9r6M6WjhS"
},
{
"code": "PD",
"label": "Property Damage Liability",
"limitPerAccident": 100000,
"property": "prp_tmGUxLpgHjmW9r6M6WjhS"
},
{
"code": "UMBI",
"label": "Uninsured Bodily Injury Liability",
"limitPerAccident": 300000,
"limitPerPerson": 100000,
"property": "prp_tmGUxLpgHjmW9r6M6WjhS"
}
],
"createdAt": "2022-01-01T00:00:00.000Z",
"documents": [
{
"createdAt": "2022-01-01T00:00:00.000Z",
"name": "Declaration Page",
"source": "carrier",
"url": "<signed-url>"
}
],
"effectiveDate": "2021-10-22T04:00:00.000Z",
"expirationDate": "2022-10-22T04:00:00.000Z",
"id": "pol_CbxGmGWnp9bGAFCC-eod2",
"insureds": [
{
"dateOfBirthYear": "1990",
"firstName": "John",
"lastName": "Smith",
"licenseNo": "•••••1234",
"licenseState": "GA",
"licenseStatus": "Valid",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "Primary"
},
{
"dateOfBirthYear": "1992",
"firstName": "Jane",
"lastName": "Doe",
"licenseNo": "•••••5678",
"licenseState": "GA",
"licenseStatus": "Valid",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "Secondary"
},
{
"dateOfBirthYear": "1992",
"firstName": "Jane",
"lastName": "Doe",
"licenseNo": "•••••5678",
"licenseState": "GA",
"licenseStatus": "Valid",
"property": "prp_tmGUxLpgHjmW9r6M6WjhS",
"type": "Primary"
}
],
"isActive": true,
"modifiedAt": "2022-01-01T00:00:00.000Z",
"policyNumber": "123456789",
"properties": [
{
"data": {
"bodyStyle": "sedan",
"make": "Mercedes-Benz",
"model": "C 300",
"vin": "WDDWJ8EB4KF776265",
"year": "2019"
},
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle"
},
{
"data": {
"bodyStyle": "minivan",
"make": "Honda",
"model": "Odyssey",
"vin": "5FNRL38209B014050",
"year": "2009"
},
"id": "prp_tmGUxLpgHjmW9r6M6WjhS",
"type": "vehicle"
}
],
"refreshedAt": "2022-01-01T00:00:00.000Z",
"thirdParties": [
{
"address": {
"addressLine1": "PO Box 123456",
"addressLine2": null,
"city": "Atlanta",
"country": null,
"postalCode": "30348-5245",
"state": "GA"
},
"name": "Super Credit Union",
"property": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "lienholder"
},
{
"address": {
"addressLine1": "PO Box 123456",
"addressLine2": null,
"city": "Atlanta",
"country": null,
"postalCode": "30348-5245",
"state": "GA"
},
"name": "Super Leasing Trust",
"property": "prp_tmGUxLpgHjmW9r6M6WjhS",
"type": "lessor"
}
],
"type": "auto"
},
"success": "boolean"
}