Lapsing and Reinstatement API

Warning

The functionality described in this topic is in “Legacy” status and will be deprecated in the future. We recommend you use the newer Cancellations and Reinstatements functionality.

Get grace period, lapse, and reinstatement information

GET /policy/{policyLocator}/graceLapseReinstatements

GraceLapseReinstatementResponse

{
  // Required
  gracePeriod : GracePeriodResponse
  reinstatements : [LapseReinstatementResponse]

  // Optional
  lapse : LapseResponse
}

Lapse API

Fetch a lapse

GET /lapse/{lapseLocator}
  • Request:

    Name

    Position

    Type

    Required

    lapseLocator

    path

    string

    required

  • Response:LapseResponse

LapseResponse

{
  // Required
  createdTimestamp : timestamp
  lapseTimestamp : timestamp
  locator : string
  reinstatementPeriodEndTimestamp : timestamp

  // Optional
  document : PolicyDocumentResponse
}

Reinstatement API

Create a reinstatement

POST /policy/{policyLocator}/createReinstatement

Fetch a reinstatement

GET /reinstatement/{reinstatementLocator}

LapseReinstatementResponse

{
  // Required
  createdTimestamp : timestamp
  currentStatus : string open | closed | invoiced | issued
  locator : string
  updatedTimestamp : timestamp
  uploadedDocuments : [PolicyDocumentResponse]

  // Optional
  invoicedTimestamp : timestamp
  invoiceLocator : string
  issuedTimestamp : timestamp
  reinstatementDocument : PolicyDocumentResponse
  reinstatementTimestamp : timestamp
}

ReinstatementStatusAndTimeResponse

{
  // Required
  status : string open | closed | invoiced | issued
  timestamp : timestamp
}

Close a reinstatement

POST /reinstatement/{reinstatementLocator}/close

Fetch the amount due for reinstatement

POST /reinstatement/{reinstatementLocator}/amountDue

ReinstatementAmountDueRequest

{
  // Required
  reinstatementTimestamp : timestamp
}

ReinstatementAmountDueResponse

{
  // Required
  grossFeesDue : number
  grossPremiumDue : number
  grossTaxesDue : number
  totalDue : number
}

Issue an invoice for a reinstatement

POST /reinstatement/{reinstatementLocator}/invoice

ReinstatementInvoiceRequest

{
  // Required
  reinstatementTimestamp : timestamp
}

Add a document to a reinstatement

POST /reinstatement/{reinstatementLocator}/addDocument
  • Request:

    Name

    Position

    Type

    Required

    displayName

    query

    string

    required

    document

    formdata

    file

    required

    documentType

    query

    string

    required

    reinstatementLocator

    path

    string

    required

  • Response:LapseReinstatementResponse

Remove a document from a reinstatement

POST /reinstatement/{reinstatementLocator}/removeDocument

ReinstatementDocumentRemoveRequest

{
  // Required
  documentLocator : string
}