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:
GracePeriodResponse
GracePeriodResponse¶
requiredlocator stringpolicyholderLocator stringpolicyLocator stringproductLocator stringstartTimestamp timestampendTimestamp timestampinvoiceLocator stringpolicyId stringoptionalcancellationLocator stringsettledTimestamp timestampdocument PolicyDocumentResponse
Cancellation
Create a cancellation¶
POST /policies/{locator}/cancellations
Request:
Name | Position | Type | Required |
---|---|---|---|
locator | path | string | required |
req | body | CancellationRequest | required |
Response:
CancellationResponse
CancellationRequest¶
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:
CancellationResponse
Update a cancellation¶
PATCH /cancellations/{locator}
Request:
Name | Position | Type | Required |
---|---|---|---|
locator | path | string | required |
req | body | CancellationUpdateRequest | required |
Response:
CancellationResponse
CancellationUpdateRequest¶
optionalname stringeffectiveTimestamp timestampcancellationCategory stringcancellationComments stringconflictHandling string block | invalidate
Issue a cancellation¶
PATCH /cancellations/{locator}/issue
Request:
Name | Position | Type | Required |
---|---|---|---|
locator | path | string | required |
Response:
CancellationResponse
Rescind a cancellation¶
PATCH /cancellations/{locator}/rescind
Request:
Name | Position | Type | Required |
---|---|---|---|
locator | path | string | required |
Response:
CancellationResponse
CancellationResponse¶
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}/price
Request:
Name | Position | Type | Required |
---|---|---|---|
locator | path | string | required |
Response:
PolicyPriceChangeResponse
Fetch cancellations for a policy¶
GET /policies/{locator}/cancellations
Request:
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}/gracePeriods
Request:
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.