Get Policy
The Get Policy endpoint returns a Policy object. Please refer to the Policy object for a detailed description of each field. Please note that this endpoint will NOT refresh the Policy object with new data from the insurance carrier.
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
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.