Reinstatements API¶
See also
See Cancellations and Reinstatements for an overview of Cancellations functionality. See Cancellations API for information about using Cancellations in the API.
Create a Reinstatement¶
PATCH /cancellations/{locator}/reinstate
Request:
Name
Position
Type
Required
locator
path
string
required
req
body
required
Response:
ReinstatementResponse
ReinstatementRequest¶
{// OptionaleffectiveTimestamp : timestampissue : booleanreinstatementDeadlineTimestamp : timestamp}
Fetch a Reinstatement¶
GET /reinstatements/{locator}
Request:
Name
Position
Type
Required
locator
path
string
required
Response:
ReinstatementResponse
Update a Reinstatement¶
PATCH /reinstatements/{locator}
Request:
Name
Position
Type
Required
locator
path
string
required
req
body
required
Response:
ReinstatementResponse
ReinstatementUpdateRequest¶
{// OptionaleffectiveTimestamp : timestampreinstatementDeadlineTimestamp : timestamp}
Accept a Reinstatement¶
PATCH /reinstatements/{locator}/accept
Request:
Name
Position
Type
Required
locator
path
string
required
Response:
ReinstatementResponse
Issue a Reinstatement¶
PATCH /reinstatements/{locator}/issue
Request:
Name
Position
Type
Required
locator
path
string
required
Response:
ReinstatementResponse
Invalidate a Reinstatement¶
PATCH /reinstatements/{locator}/invalidate
Request:
Name
Position
Type
Required
locator
path
string
required
Response:
ReinstatementResponse
Fetch Pricing for a Reinstatement¶
GET /reinstatements/{locator}/price
Request:
Name
Position
Type
Required
locator
path
string
required
Response:
PolicyPriceChangeResponse
ReinstatementResponse¶
{// RequiredcancellationLocator : stringcreatedTimestamp : timestampdocuments : [PolicyDocumentResponse]effectiveTimestamp : timestamplocator : stringstate : string draft | accepted | issued | expiredupdatedTimestamp : timestamp// OptionalinvoiceLocator : stringissuedTimestamp : timestampprice : PolicyPriceChangeResponsereinstatementDeadlineTimestamp : timestampreinstatementPaymentAmount : number}
The invoiceLocator
, price
, and reinstatementPaymentAmount
will only be included for accepted
or issued
reinstatements. The issuedTimestamp
will only be included for issued
reinstatements.