Cancellations API

See also

See Cancellations and Reinstatements for an overview of Cancellations functionality. See Reinstatements API for information about using Reinstatements in the API.

Endpoint Index

ActionEndpoint
Fetch a grace periodGET /gracePeriod/{gracePeriodLocator}
Update a grace periodPATCH /gracePeriod/{gracePeriodLocator}
Create a cancellationPOST /policies/{locator}/cancellations
Fetch a cancellationGET /cancellations/{locator}
Update a cancellationPATCH /cancellations/{locator}
Issue a cancellationPATCH /cancellations/{locator}/issue
Rescind a cancellationPATCH /cancellations/{locator}/rescind
Fetch Pricing for a cancellationGET /cancellations/{locator}/price
Fetch cancellations for a policyGET /policies/{locator}/cancellations
Fetch grace periods for a policyGET /policy/{policyLocator}/gracePeriods

Grace Periods

Fetch a grace period
GET /gracePeriod/{gracePeriodLocator}
    Request:
    NamePositionTypeRequired
    gracePeriodLocatorpathstringrequired
GracePeriodResponse
required
locator string
policyholderLocator string
policyLocator string
productLocator string
startTimestamp timestamp
endTimestamp timestamp
invoiceLocator string
policyId string (deprecated)

optional
cancellationLocator string
cancelEffectiveTimestamp timestamp
settledTimestamp timestamp
Update a grace period
PATCH /gracePeriod/{gracePeriodLocator}
GracePeriodUpdateRequest
optional
endTimestamp timestamp
cancelEffectiveTimestamp timestamp
resetCancelEffectiveTimestamp timestamp

Important

Updating a grace period’s end timestamp controls when the policy will lapse if invoices remain past due. If set to the current time the policy will lapse immediately.

Cancellation

Create a cancellation
POST /policies/{locator}/cancellations
CancellationRequest
required
name string
effectiveTimestamp timestamp

optional
cancellationCategory string
cancellationComments string
issue boolean
conflictHandling string block | invalidate
Fetch a cancellation
GET /cancellations/{locator}
Update a cancellation
PATCH /cancellations/{locator}
CancellationUpdateRequest
optional
name string
effectiveTimestamp timestamp
cancellationCategory string
cancellationComments string
conflictHandling string block | invalidate
Issue a cancellation
PATCH /cancellations/{locator}/issue
Rescind a cancellation
PATCH /cancellations/{locator}/rescind
CancellationResponse
required
locator string
name string
title string
policyLocator string
state string draft | issued | rescinded | reinstated
createdTimestamp timestamp
effectiveTimestamp timestamp
policyModificationLocator string
conflictHandling string block | invalidate

optional
issuedTimestamp timestamp
cancellationCategory string
cancellationComments string
invoiceLocator string
reinstatement ReinstatementResponse
Fetch Pricing for a cancellation
GET /cancellations/{locator}/price
Fetch cancellations for a policy
GET /policies/{locator}/cancellations

If there are no cancellations for the policy, an empty array will be returned.

Fetch grace periods for a policy
GET /policy/{policyLocator}/gracePeriods
    Request:
    NamePositionTypeRequired
    policyLocatorpathstringrequired

After a grace period expires a cancellation named lapse will be created.

Legacy Lapsing and Reinstatement

See the Legacy Grace, Lapse & Reinstatement API guide for details about the previous version of this functionality.