Get Policy
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",
"limitPerAccident": 500000,
"limitPerPerson": 250000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "PD",
"label": "Property Damage",
"limitPerAccident": 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": "UMBI",
"label": "Uninsured Bodily Injury",
"limitPerAccident": 300000,
"limitPerPerson": 100000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
}
],
"createdAt": "2022-01-01T00:00:00.000Z",
"documents": {
"createdAt": "2022-01-01T00:00:00.000Z",
"name": "Declaration Page",
"source": "carrier",
"type": [
"declaration-page"
],
"url": "<signed-url>"
},
"effectiveDate": "2022-10-22T04:00:00.000Z",
"expirationDate": "2023-10-22T04:00:00.000Z",
"id": "pol_CbxGmGWnp9bGAFCC-eod2",
"insureds": {
"dateOfBirthYear": "1993",
"firstName": "Armaan",
"lastName": "Sikand",
"licenseNo": "•••••7259",
"licenseState": "GA",
"type": "primary"
},
"isActive": true,
"modifiedAt": "2022-01-01T00:00:00.000Z",
"policyNumber": "123456789",
"premium": 999.99,
"properties": {
"data": {
"make": "HONDA",
"model": "CR-V",
"vin": "SMTD44GN3HT812287",
"year": "2017"
},
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle"
},
"refreshedAt": "2022-01-01T00:00:00.000Z",
"thirdParties": {
"address": {
"addressLine1": "Po Box 105205",
"city": "Atlanta",
"postalCode": "30348-5205",
"state": "GA"
},
"name": "Super Leasing Trust",
"type": "lessor"
},
"type": "auto"
},
"success": true
}
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 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
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",
"limitPerAccident": 500000,
"limitPerPerson": 250000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
},
{
"code": "PD",
"label": "Property Damage",
"limitPerAccident": 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": "UMBI",
"label": "Uninsured Bodily Injury",
"limitPerAccident": 300000,
"limitPerPerson": 100000,
"property": "prp_uSdzLVpi8c76H7kl6AQ-F"
}
],
"createdAt": "2022-01-01T00:00:00.000Z",
"documents": {
"createdAt": "2022-01-01T00:00:00.000Z",
"name": "Declaration Page",
"source": "carrier",
"type": [
"declaration-page"
],
"url": "<signed-url>"
},
"effectiveDate": "2022-10-22T04:00:00.000Z",
"expirationDate": "2023-10-22T04:00:00.000Z",
"id": "pol_CbxGmGWnp9bGAFCC-eod2",
"insureds": {
"dateOfBirthYear": "1993",
"firstName": "Armaan",
"lastName": "Sikand",
"licenseNo": "•••••7259",
"licenseState": "GA",
"type": "primary"
},
"isActive": true,
"modifiedAt": "2022-01-01T00:00:00.000Z",
"policyNumber": "123456789",
"premium": 999.99,
"properties": {
"data": {
"make": "HONDA",
"model": "CR-V",
"vin": "SMTD44GN3HT812287",
"year": "2017"
},
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle"
},
"refreshedAt": "2022-01-01T00:00:00.000Z",
"thirdParties": {
"address": {
"addressLine1": "Po Box 105205",
"city": "Atlanta",
"postalCode": "30348-5205",
"state": "GA"
},
"name": "Super Leasing Trust",
"type": "lessor"
},
"type": "auto"
},
"success": true
}