POST
/
sandbox
/
policies
/
{id}
/
event

Authorizations

x-client-secret
string
headerrequired

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

x-client-id
string
required

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

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.

Body

application/json
type
enum<string> | null

Type of insurance policy that the Policy object represents.

Available options:
auto,
motorcycle,
home,
condo
carrier
string

Insurance carrier that is the source for the Policy data.

policyNumber
string | null

Identifier of the policy, as specified by the insurance carrier.

isActive
boolean | null

Active status of the policy, as specified by the insurance carrier.

effectiveDate
string | null

ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier.

expirationDate
string | null

ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.

premium
number | null

Total policy premium, as specified by the insurance carrier. Note: only available for type=home policies

address
object

Primary address associated with the policy.

coverages
object[]

List of coverage types and levels offered by the policy.

properties
object[]

List of properties (such as a vehicle or dwelling) afforded coverage by the policy.

insureds
object[]

List of entities (such as an individuals or businesses) afforded direct coverage by the policy.

thirdParties
object[]

List of external parties with interest in the policy.

documents
object[]

List of documents (such as declaration pages and policy agreements) associated with the policy.

Response

200 - application/json
success
boolean
required

Indicates whether the operation was performed successfully.

data
object
required