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.
Endpoint Index
| Action | Endpoint |
|---|---|
| Create a reinstatement | PATCH /cancellations/{locator}/reinstate |
| Fetch a reinstatement | GET /reinstatements/{locator} |
| Update a reinstatement | PATCH /reinstatements/{locator} |
| Accept a reinstatement | PATCH /reinstatements/{locator}/accept |
| Issue a reinstatement | PATCH /reinstatements/{locator}/issue |
| Invalidate a reinstatement | PATCH /reinstatements/{locator}/invalidate |
| Fetch pricing for a reinstatement | GET /reinstatements/{locator}/price |
Details
Create a reinstatement¶
PATCH /cancellations/{locator}/reinstateRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
| req | body | ReinstatementCreateRequest | required |
Response:
ReinstatementResponseReinstatementCreateRequest¶
optionaleffectiveTimestamp timestampreinstatementDeadlineTimestamp timestampissue boolean
Fetch a reinstatement¶
GET /reinstatements/{locator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
ReinstatementResponseUpdate a reinstatement¶
PATCH /reinstatements/{locator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
| req | body | ReinstatementUpdateRequest | required |
Response:
ReinstatementResponseReinstatementUpdateRequest¶
optionaleffectiveTimestamp timestampreinstatementDeadlineTimestamp timestamp
Accept a reinstatement¶
PATCH /reinstatements/{locator}/acceptRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
ReinstatementResponseIssue a reinstatement¶
PATCH /reinstatements/{locator}/issueRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
ReinstatementResponseInvalidate a reinstatement¶
PATCH /reinstatements/{locator}/invalidateRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
ReinstatementResponseFetch pricing for a reinstatement¶
GET /reinstatements/{locator}/priceRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| locator | path | string | required |
Response:
PolicyPriceChangeResponseReinstatementResponse¶
requiredlocator stringcancellationLocator stringstate string draft | accepted | issued | expiredcreatedTimestamp timestampupdatedTimestamp timestampeffectiveTimestamp timestampdocuments [PolicyDocumentResponse]optionalissuedTimestamp timestampreinstatementDeadlineTimestamp timestampreinstatementPaymentAmount numberinvoiceLocator string
The invoiceLocator, price, and reinstatementPaymentAmount will only be included for accepted or issued reinstatements. The issuedTimestamp will only be included for issued reinstatements.