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.
Grace Periods¶
Fetch a grace period¶
GET /gracePeriod/{gracePeriodLocator}
Request:
Name
Position
Type
Required
gracePeriodLocator
path
string
required
Response:
GracePeriodResponse
GracePeriodResponse¶
{// RequiredendTimestamp : timestampinvoiceLocator : stringlocator : stringpolicyholderLocator : stringpolicyId : stringpolicyLocator : stringproductLocator : stringstartTimestamp : timestamp// OptionalcancellationLocator : stringdocument : PolicyDocumentResponsesettledTimestamp : timestamp}
Cancellation¶
Create a Cancellation¶
POST /policies/{locator}/cancellations
Request:
Name
Position
Type
Required
locator
path
string
required
req
body
required
Response:
CancellationResponse
CancellationRequest¶
{// RequiredeffectiveTimestamp : timestampname : string// OptionalconflictHandling : string block | invalidateissue : boolean}
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
required
Response:
CancellationResponse
CancellationUpdateRequest¶
{// OptionalconflictHandling : string block | invalidateeffectiveTimestamp : timestampname : string}
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¶
{// RequiredconflictHandling : string block | invalidatecreatedTimestamp : timestampdocuments : [PolicyDocumentResponse]effectiveTimestamp : timestamplocator : stringname : stringpolicyLocator : stringpolicyModificationLocator : stringstate : string draft | issued | rescinded | reinstatedtitle : string// OptionalinvoiceLocator : stringissuedTimestamp : timestampprice : PolicyPriceChangeResponsereinstatement : 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.