Lapsing and Reinstatement API

Grace Period API

Fetch a grace period

GET /gracePeriod/{gracePeriodLocator}
  • Request:

    Name

    Position

    Type

    Required

    gracePeriodLocator

    path

    string

    required

  • Response:GracePeriodResponse

GracePeriodResponse

{
  // Required
  "endTimestamp" : integer
  "invoiceLocator" : string
  "locator" : string
  "policyholderLocator" : string
  "policyLocator" : string
  "productLocator" : string
  "startTimestamp" : integer

  // Optional
  "cancellationLocator" : string
  "document" : PolicyDocumentResponse
  "settledTimestamp" : integer
}

Lapse API

Fetch a lapse

GET /lapse/{lapseLocator}
  • Request:

    Name

    Position

    Type

    Required

    lapseLocator

    path

    string

    required

  • Response:LapseResponse

LapseResponse

{
  // Required
  "createdTimestamp" : integer
  "lapseTimestamp" : integer
  "locator" : string
  "reinstatementPeriodEndTimestamp" : integer

  // Optional
  "document" : PolicyDocumentResponse
}

Reinstatement API

Create a reinstatement

POST /policy/{policyLocator}/createReinstatement

Fetch a reinstatement

GET /reinstatement/{reinstatementLocator}

ReinstatementResponse

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

  // Optional
  "invoicedTimestamp" : integer
  "invoiceLocator" : string
  "issuedTimestamp" : integer
  "reinstatementDocument" : PolicyDocumentResponse
  "reinstatementTimestamp" : integer
}

ReinstatementStatusAndTimeResponse

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

Close a reinstatement

POST /reinstatement/{reinstatementLocator}/close

Fetch the amount due for reinstatement

POST /reinstatement/{reinstatementLocator}/amountDue

ReinstatementAmountDueRequest

{
  // Required
  "reinstatementTimestamp" : integer
}

ReinstatementAmountDueResponse

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

Issue an invoice for a reinstatement

POST /reinstatement/{reinstatementLocator}/invoice

ReinstatementInvoiceRequest

{
  // Required
  "reinstatementTimestamp" : integer
}

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:ReinstatementResponse

Remove a document from a reinstatement

POST /reinstatement/{reinstatementLocator}/removeDocument

ReinstatementDocumentRemoveRequest

{
  // Required
  "documentLocator" : string
}