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/{cancellationLocator}/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/{cancellationLocator}/reinstate

Request:

Name	Position	Type	Required
cancellationLocator	path	string	required
req	body	ReinstatementCreateRequest	required

Response: ReinstatementResponse

ReinstatementCreateRequest

optional
effectiveTimestamp timestamp
reinstatementDeadlineTimestamp timestamp
issue boolean

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	ReinstatementUpdateRequest	required

Response: ReinstatementResponse

ReinstatementUpdateRequest

optional
effectiveTimestamp timestamp
reinstatementDeadlineTimestamp 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

required
locator string
cancellationLocator string
state string draft | accepted | issued | expired
createdTimestamp timestamp
updatedTimestamp timestamp
effectiveTimestamp timestamp
documents [PolicyDocumentResponse]

optional
issuedTimestamp timestamp
reinstatementDeadlineTimestamp timestamp
reinstatementPaymentAmount number
invoiceLocator string
price PolicyPriceChangeResponse

The invoiceLocator, price, and reinstatementPaymentAmount will only be included for accepted or issued reinstatements. The issuedTimestamp will only be included for issued reinstatements.