GET
/
policies
/
{id}
/
report
Header
Path
Query
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

x-client-id
string
required

Your client ID. This will be shared with you during onboarding.

x-client-secret
string
required

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all!

x-destination-client-id
string

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.

x-access-token
string
required

The access token required for access to the requested Account. Returned as part of the Token Exchange flow in exchangeToken.

Path Parameters

id
string
required

The unique ID for the requested policy. Returned by Get Account for each Policy associated with the Account.

Query Parameters

expand
boolean

Set to true if you would like to expand related entities (e.g., account, policy, client). Defaults to false.

mode
string

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

200 - application/json
data
object
success
boolean

Indicates whether the operation was performed successfully.

Get PolicyGet Carrier