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

• Response:ReinstatementResponse

ReinstatementRequest

{
  // Optional
  effectiveTimestamp : timestamp
  issue : boolean
  reinstatementDeadlineTimestamp : 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	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
  cancellationLocator : string
  createdTimestamp : timestamp
  documents : [PolicyDocumentResponse]
  effectiveTimestamp : timestamp
  locator : string
  state : string draft | accepted | issued | expired
  updatedTimestamp : timestamp

  // Optional
  invoiceLocator : string
  issuedTimestamp : timestamp
  price : PolicyPriceChangeResponse
  reinstatementDeadlineTimestamp : timestamp
  reinstatementPaymentAmount : number
}

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