Get Policy Report
The Get Policy Report method returns a PDF report of the requested Policy object, including high-level policy information (e.g., policy number) and any children objects (e.g., Coverages) associated with the Policy.
Please note, this route is currently only available in the sandbox environment.
curl --request GET \
--url https://api.axle.insure/policies/{id}/report \
--header 'x-access-token: <x-access-token>' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
{
"data": {
"policy": "pol_123456789",
"report": "https://axle-labs-policy-reports..."
},
"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.
Specify desired return type of the report. Options: url
for a signedUrl or base64
for the full file returned in base64 encoding. Defaults to url
.
Response
Indicates whether the operation was performed successfully.
curl --request GET \
--url https://api.axle.insure/policies/{id}/report \
--header 'x-access-token: <x-access-token>' \
--header 'x-client-id: <x-client-id>' \
--header 'x-client-secret: <x-client-secret>'
{
"data": {
"policy": "pol_123456789",
"report": "https://axle-labs-policy-reports..."
},
"success": true
}