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
| Action | Endpoint |
|---|---|
| Fetch a grace period | GET /gracePeriod/{gracePeriodLocator} |
| Create a cancellation | POST /policies/{locator}/cancellations |
| Fetch a cancellation | GET /cancellations/{locator} |
| Update a cancellation | PATCH /cancellations/{locator} |
| Issue a cancellation | PATCH /cancellations/{locator}/issue |
| Rescind a cancellation | PATCH /cancellations/{locator}/rescind |
| Fetch Pricing for a cancellation | GET /cancellations/{locator}/price |
| Fetch cancellations for a policy | GET /policies/{locator}/cancellations |
| Fetch grace periods for a policy | GET /policy/{policyLocator}/gracePeriods |
Grace Periods
Fetch a grace period¶
GET /gracePeriod/{gracePeriodLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| gracePeriodLocator | path | string | required |
Response:
GracePeriodResponseGracePeriodResponse¶
requiredlocator stringpolicyholderLocator stringpolicyLocator stringproductLocator stringstartTimestamp timestampendTimestamp timestampinvoiceLocator stringpolicyId stringoptionalcancellationLocator stringsettledTimestamp timestampdocument PolicyDocumentResponse
Cancellation
Create a cancellation¶
POST /policies/{locator}/cancellationsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
| req | body | CancellationRequest | required |
Response:
CancellationResponseCancellationRequest¶
requiredname stringeffectiveTimestamp timestampoptionalcancellationCategory stringcancellationComments stringissue booleanconflictHandling string block | invalidate
Fetch a cancellation¶
GET /cancellations/{locator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
CancellationResponseUpdate a cancellation¶
PATCH /cancellations/{locator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
| req | body | CancellationUpdateRequest | required |
Response:
CancellationResponseCancellationUpdateRequest¶
optionalname stringeffectiveTimestamp timestampcancellationCategory stringcancellationComments stringconflictHandling string block | invalidate
Issue a cancellation¶
PATCH /cancellations/{locator}/issueRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
CancellationResponseRescind a cancellation¶
PATCH /cancellations/{locator}/rescindRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
CancellationResponseCancellationResponse¶
requiredlocator stringname stringtitle stringpolicyLocator stringstate string draft | issued | rescinded | reinstatedcreatedTimestamp timestampeffectiveTimestamp timestampdocuments [PolicyDocumentResponse]policyModificationLocator stringconflictHandling string block | invalidateoptionalissuedTimestamp timestampcancellationCategory stringcancellationComments stringinvoiceLocator stringreinstatement ReinstatementResponse
Fetch Pricing for a cancellation¶
GET /cancellations/{locator}/priceRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
PolicyPriceChangeResponseFetch cancellations for a policy¶
GET /policies/{locator}/cancellationsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
[CancellationResponse]If there are no cancellations for the policy, an empty array will be returned.
Fetch grace periods for a policy¶
GET /policy/{policyLocator}/gracePeriodsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| policyLocator | path | string | required |
Response:
[GracePeriodResponse]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.