Cancellation API

Submitting cancellation request

Key	Type	Description
policy number	String	The unique policy number for the policy you wish to cancel.

This endpoint can be called either with a GET or POST request. A GET request or an empty POST request means you want the first form for the policy. Otherwise a POST request validates the request and then it marks the policy as having a cancellation request ready for review. The following is an example of POST request:

{
    {
        "form": null,
        “has_errors": false,
        "next_action": "display",
        "content_data": {
            “title ": " Cancellation request received ",
            "content": " <p>We have received your cancellation request for policy M9Dgpei and will be processed shortly.</p>",
            "redirect_to": "PORTFOLIO"
        }
    }
}

Key	Type	Description
form	Dict	An object representing the form schema which needs to be completed.
has_errors	Boolean	A boolean flag to indicated if the form has an errors. This will be false if you are requesting the form.
next_action	String	String that lets you continue.
content_data	Optional[Dict[str, Any]]	An object which contains a list of attributes.
content_data.redirect_to	String	The URL you would like the backend to redirect to on submission of cancellation.

Errors

This endpoint will raise a 403 error code if you attempt to send the request again for the same policy.

Code	Reason
403

Please refer to the Error Handling section for further details, on errors and error handling.