1 of 1

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

Headers

{
    "renewal_id": "xeJsp-UcMlR-FXv0U-UPD",
    "quotes": [
        {
            "id": "25fb6ea3-3236-4743-b077-ce77b8631fe0",
            "policy_start_date": "2021-07-27T13:25:00+00:00",
            "policy_end_date": "2021-08-26T13:25:00+00:00",
            "status": "RECEIVED",
            "price": 16.0,
            "price_formatted": "US$16.00",
            "policy": {
                "policy_type": "renters_insurance",
                "policy_name": "Renters Insurance",
                "policy_code": "RE01RHI",
                "policy_version": "cca6cb3a-5cdf-412b-959a-9911e30e7dd1",
                "category": null,
                "content": {},
                "underwriter": {
                    "disclaimer": "This plan is arranged by XCover.com and underwritten by Markel International Insurance Company Limited",
                    "name": "Markel International Insurance Company Limited"
                },
                "claim_selector_id": "",
                "show_benefits": true
            },
            "insured": [
                {
                }
            ],
            "tax": {
                "total_tax": 0.0,
                "total_amount_without_tax": 16.0,
                "total_tax_formatted": "US$0.00",
                "total_amount_without_tax_formatted": "US$16.00",
                "taxes": [
                ]
            },
            "duration": "30 00:00:00",
            "benefits": [
                {}
            ],
            "commission": {
            },
            "created_at": "2021-06-22T16:04:55.416289Z",
            "confirmed_at": null,
            "updated_at": "2021-06-22T16:04:55.416306Z",
            "cancelled_at": null,
            "is_renewable": false,
            "is_pricebeat_enabled": null,
            "cover_amount": null,
            "cover_amount_formatted": null,
            "pds_url": "https://www.xcover.com/en-us/pds/4XNE7-B8YGP-INS?policy_type=renters_insurance_v1",
            "attachments": [],
            "files": [],
            "extra_fields": {
            },
            "surcharge": {
                "total_amount": null,
                "total_amount_formatted": null,
                "surcharges": null
            },
            "discount_price": 16.0,
            "discount_price_formatted": "US$16.00",
            "discount_amount": 0.0,
            "discount_amount_formatted": "US$0.00"
}

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

Headers

Request Body

{
}

{
    "quotes": [
        {
            "id": "{{quote_1_id}}",
            "policy_start_date": "{{policy_start_date}}",
            "insured": [
                {
                    ...
                }
            ]
        }
    ]
}

Renewal Workflow

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/

Path Parameters

Name

Type

Description

Headers

Name

Type

Description

{
    "renewal_id": "xeJsp-UcMlR-FXv0U-UPD",
    "quotes": [
        {
            "id": "25fb6ea3-3236-4743-b077-ce77b8631fe0",
            "policy_start_date": "2021-07-27T13:25:00+00:00",
            "policy_end_date": "2021-08-26T13:25:00+00:00",
            "status": "RECEIVED",
            "price": 16.0,
            "price_formatted": "US$16.00",
            "policy": {
                "policy_type": "renters_insurance",
                "policy_name": "Renters Insurance",
                "policy_code": "RE01RHI",
                "policy_version": "cca6cb3a-5cdf-412b-959a-9911e30e7dd1",
                "category": null,
                "content": {},
                "underwriter": {
                    "disclaimer": "This plan is arranged by XCover.com and underwritten by Markel International Insurance Company Limited",
                    "name": "Markel International Insurance Company Limited"
                },
                "claim_selector_id": "",
                "show_benefits": true
            },
            "insured": [
                {
                }
            ],
            "tax": {
                "total_tax": 0.0,
                "total_amount_without_tax": 16.0,
                "total_tax_formatted": "US$0.00",
                "total_amount_without_tax_formatted": "US$16.00",
                "taxes": [
                ]
            },
            "duration": "30 00:00:00",
            "benefits": [
                {}
            ],
            "commission": {
            },
            "created_at": "2021-06-22T16:04:55.416289Z",
            "confirmed_at": null,
            "updated_at": "2021-06-22T16:04:55.416306Z",
            "cancelled_at": null,
            "is_renewable": false,
            "is_pricebeat_enabled": null,
            "cover_amount": null,
            "cover_amount_formatted": null,
            "pds_url": "https://www.xcover.com/en-us/pds/4XNE7-B8YGP-INS?policy_type=renters_insurance_v1",
            "attachments": [],
            "files": [],
            "extra_fields": {
            },
            "surcharge": {
                "total_amount": null,
                "total_amount_formatted": null,
                "surcharges": null
            },
            "discount_price": 16.0,
            "discount_price_formatted": "US$16.00",
            "discount_amount": 0.0,
            "discount_amount_formatted": "US$0.00"
}

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

Headers

Name

Type

Description

Request Body

Name

Type

Description

{
}

{
    "quotes": [
        {
            "id": "{{quote_1_id}}",
            "policy_start_date": "{{policy_start_date}}",
            "insured": [
                {
                    ...
                }
            ]
        }
    ]
}