Renewal Workflow
For certain policy types (eg. Warranty/Product Insurance/Renters) a renewal period may be established for ongoing protection. Eg. A laptop warranty with an annual renewal cycle. Or a renters insurance product
Before the policy end date the customer should be sent a notification that their policy is expiring and will be (auto) renewed (depending on their settings in your platform).
An example of the renewal workflow is illustrated below.
Quote for Renewal
PATCH
https://api.xcover.com/x/partners/:partner_id/renewals/:quote_package_id/quote_for_renewal/
Generates an updated booking with a renewal price that should be charged to the customer. It also contains any other changes to benefits/limits or policy wording that may have changed since the first policy was purchased. Request contains no payload.
Path Parameters
Name | Type | Description |
---|---|---|
partner_id | string | Unique Partner Code |
quote_package_id | string | Quote Package ID (INS) |
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
Date | string | Current Datetime |
Authorization | string | HMAC Signature |
X-API-Key | string | API Key |
Confirm Renewal
To confirm a renewal once payment has been collected a request to the following endpoint needs to be made.
Confirm Renewal
POST
https://api.xcover.com/x/partners/:partner_id/renewals/:quote_package_id/confirm/:renewal_id/
Confirms the renewal and issues the updated policy to the customer.
Path Parameters
Name | Type | Description |
---|---|---|
partner_id | string | Unique Partner ID |
quote_package_id | string | Quote Package ID (INS) |
renewal_id | string | ID referencing the renewal |
Headers
Name | Type | Description |
---|---|---|
Content-Type | string | application/json |
Date | string | Current Datetime |
Authorization | string | HMAC Signature |
X-API-Key | string | API Key |
Request Body
Name | Type | Description |
---|---|---|
id* | String | The policy quote requires updating. |
policy_start_date* | String | The new policy start date |
Last updated