Get Policy Report
The Get Policy Report method returns a PDF or image 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.
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 Exchange Token.
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
.
true
, false
Specify desired return mode of the report. Options: url
for a signedUrl or base64
for the full file returned in base64 encoding. Defaults to url
.
url
, base64
Specify desired return format of the report. Options: pdf
or jpeg
. Defaults to pdf
.
pdf
, jpeg
Response
Indicates whether the operation was performed successfully.