CoverOptOut

What it does: Records whether a customer has opted in or out of RentalCover coverage.

When to call it: Immediately after the customer makes their decision, regardless of whether they accept or decline.

Required call

This endpoint is mandatory for every customer shown the insurance offer. Failing to call it when a customer declines may result in compliance issues.

POST /insurances/coverOptOut/<reference>

Example requests

Customer opts out

curl -i -X POST \
  -H "X_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"CoverOptIn": 0, "PartnerReference": "PARTNER-REF-001"}' \
  https://api-staging.rentalcover.com/insurances/coverOptOut/AB12-345C-INS

Customer opts in

curl -i -X POST \
  -H "X_API_KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"CoverOptIn": 1, "PartnerReference": "PARTNER-REF-001"}' \
  https://api-staging.rentalcover.com/insurances/coverOptOut/AB12-345C-INS

Request parameters

Parameter	Required?	Description
reference (URL)	Required	The RentalCover booking reference from the Quote response.
CoverOptIn	Required	1 = customer accepted cover. 0 = customer declined cover.
PartnerReference	Optional	Your internal booking reference.

Response

Returns a Booking Response. Status is returned on success.

{
    "Status":"success"
}