Overview
Policy actions allow you to request carrier-side changes to a policy on behalf of your user. Once submitted, Axle will process the request and the policy will be updated once the action is complete. The following operations are currently supported:| Operation | Description |
|---|---|
request-primary-lienholder | Request that your organization be added as the primary lienholder on the policy. |
Executing a Policy Action
Submit aPOST /policies/{policyId}/actions request with the desired operation.
Request Sample: cURL
Response Sample
Webhooks
APOST request will be sent to the webhookUri you provided when generating the Ignition token at each stage of the action lifecycle.
All policy action webhook events include top-level id, type, and createdAt. The data object includes client, policy, operation, input, and optionally user and metadata.
Example webhook payload
Event types
Events follow this lifecycle:policy-action.request-initiated -> policy-action.request-succeeded or policy-action.request-failed -> (on success) policy-action.policy-refresh-succeeded or policy-action.policy-refresh-failed.
policy-action.request-initiated
The action has been received and Axle has begun processing the insurance carrier request.policy-action.request-succeeded
The insurance carrier successfully processed the request.policy-action.request-failed
The insurance carrier request failed, or the action expired before completing.policy-action.policy-refresh-succeeded
After a successful insurance carrier request, Axle was able to retrieve the latest policy data.policy-action.policy-refresh-failed
After a successful insurance carrier request, Axle was unable to refresh the policy data. The carrier request itself succeeded, but the policy data may not yet reflect the change.Error Codes
If the request does not succeed, you may receive a400 Bad Request or 500 Internal Server Error response.
400 Bad Request
| errorCode | message | When it occurs |
|---|---|---|
policy-action-not-supported | Policy action <operation> is not supported for this policy. | The requested operation is not available for this policy. |
500 Internal Server Error
| errorCode | message | When it occurs |
|---|---|---|
default | Oops something went wrong. Please try again later. | Default when an unexpected server error occurs. Retrying may succeed. |