Lapsing and Reinstatement API (Legacy)
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.
Endpoint Index
| Action | Endpoint |
|---|---|
| Fetch grace period, lapse, and reinstatement information | GET /policy/{policyLocator}/graceLapseReinstatements |
| Fetch a lapse | GET /lapse/{lapseLocator} |
| Create a reinstatement | POST /policy/{policyLocator}/createReinstatement |
| Fetch a reinstatement | GET /reinstatement/{reinstatementLocator} |
| Close a reinstatement | POST /reinstatement/{reinstatementLocator}/close |
| Fetch the amount due for reinstatement | POST /reinstatement/{reinstatementLocator}/amountDue |
| Issue an invoice for a reinstatement | POST /reinstatement/{reinstatementLocator}/invoice |
| Add a document to a reinstatement | POST /reinstatement/{reinstatementLocator}/addDocument |
| Remove a document from a reinstatement | POST /reinstatement/{reinstatementLocator}/removeDocument |
Grace Periods
Fetch grace period, lapse, and reinstatement information¶
GET /policy/{policyLocator}/graceLapseReinstatementsRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| policyLocator | path | string | required |
Response:
[GraceLapseReinstatementResponse]GraceLapseReinstatementResponse¶
requiredgracePeriod GracePeriodResponsereinstatements [LapseReinstatementResponse]optionallapse LapseResponse
Policy Lapse
Fetch a lapse¶
GET /lapse/{lapseLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| lapseLocator | path | string | required |
Response:
LapseResponseLapseResponse¶
requiredlocator stringcreatedTimestamp timestamplapseTimestamp timestampreinstatementPeriodEndTimestamp timestampoptionaldocument PolicyDocumentResponse
Reinstatement
Create a reinstatement¶
POST /policy/{policyLocator}/createReinstatementRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| policyLocator | path | string | required |
Response:
LapseReinstatementResponseFetch a reinstatement¶
GET /reinstatement/{reinstatementLocator}Request:
| Name | Position | Type | Required |
|---|---|---|---|
| reinstatementLocator | path | string | required |
Response:
LapseReinstatementResponseLapseReinstatementResponse¶
requiredlocator stringcreatedTimestamp timestampupdatedTimestamp timestampcurrentStatus string open | closed | invoiced | issuedstatuses [ReinstatementStatusAndTimeResponse]uploadedDocuments [PolicyDocumentResponse]optionalissuedTimestamp timestampinvoicedTimestamp timestampreinstatementTimestamp timestampinvoiceLocator stringreinstatementDocument PolicyDocumentResponse
ReinstatementStatusAndTimeResponse¶
requiredtimestamp timestampstatus string open | closed | invoiced | issued
Close a reinstatement¶
POST /reinstatement/{reinstatementLocator}/closeRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| reinstatementLocator | path | string | required |
Response:
LapseReinstatementResponseFetch the amount due for reinstatement¶
POST /reinstatement/{reinstatementLocator}/amountDueRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| reinstatementLocator | path | string | required |
| request | body | ReinstatementAmountDueRequest | required |
Response:
ReinstatementAmountDueResponseReinstatementAmountDueRequest¶
requiredreinstatementTimestamp timestamp
ReinstatementAmountDueResponse¶
requiredgrossFeesDue numbergrossPremiumDue numbergrossTaxesDue numbertotalDue number
Issue an invoice for a reinstatement¶
POST /reinstatement/{reinstatementLocator}/invoiceRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| reinstatementLocator | path | string | required |
| request | body | ReinstatementInvoiceRequest | required |
Response:
LapseReinstatementResponseReinstatementInvoiceRequest¶
requiredreinstatementTimestamp timestamp
Add a document to a reinstatement¶
POST /reinstatement/{reinstatementLocator}/addDocumentRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| displayName | query | string | required |
| document | formdata | file | required |
| documentType | query | string | required |
| reinstatementLocator | path | string | required |
Response:
LapseReinstatementResponseRemove a document from a reinstatement¶
POST /reinstatement/{reinstatementLocator}/removeDocumentRequest:
| Name | Position | Type | Required |
|---|---|---|---|
| reinstatementLocator | path | string | required |
| request | body | ReinstatementDocumentRemoveRequest | required |
Response:
LapseReinstatementResponseReinstatementDocumentRemoveRequest¶
requireddocumentLocator string