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}/graceLapseReinstatements
Request:
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:
LapseResponse
LapseResponse¶
requiredlocator stringcreatedTimestamp timestamplapseTimestamp timestampreinstatementPeriodEndTimestamp timestampoptionaldocument PolicyDocumentResponse
Reinstatement
Create a reinstatement¶
POST /policy/{policyLocator}/createReinstatement
Request:
Name | Position | Type | Required |
---|---|---|---|
policyLocator | path | string | required |
Response:
LapseReinstatementResponse
Fetch a reinstatement¶
GET /reinstatement/{reinstatementLocator}
Request:
Name | Position | Type | Required |
---|---|---|---|
reinstatementLocator | path | string | required |
Response:
LapseReinstatementResponse
LapseReinstatementResponse¶
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}/close
Request:
Name | Position | Type | Required |
---|---|---|---|
reinstatementLocator | path | string | required |
Response:
LapseReinstatementResponse
Fetch the amount due for reinstatement¶
POST /reinstatement/{reinstatementLocator}/amountDue
Request:
Name | Position | Type | Required |
---|---|---|---|
reinstatementLocator | path | string | required |
request | body | ReinstatementAmountDueRequest | required |
Response:
ReinstatementAmountDueResponse
ReinstatementAmountDueRequest¶
requiredreinstatementTimestamp timestamp
ReinstatementAmountDueResponse¶
requiredgrossFeesDue numbergrossPremiumDue numbergrossTaxesDue numbertotalDue number
Issue an invoice for a reinstatement¶
POST /reinstatement/{reinstatementLocator}/invoice
Request:
Name | Position | Type | Required |
---|---|---|---|
reinstatementLocator | path | string | required |
request | body | ReinstatementInvoiceRequest | required |
Response:
LapseReinstatementResponse
ReinstatementInvoiceRequest¶
requiredreinstatementTimestamp 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
Request:
Name | Position | Type | Required |
---|---|---|---|
reinstatementLocator | path | string | required |
request | body | ReinstatementDocumentRemoveRequest | required |
Response:
LapseReinstatementResponse
ReinstatementDocumentRemoveRequest¶
requireddocumentLocator string