> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/rentalcover/shared-reference/response-objects.md).

# Response Objects

Several endpoints return the same nested objects. Each is defined once here. When an endpoint's response table lists a field as a named object type, refer to this section.

## Policy object

Returned by: Quote, InstantBooking (subset), Purchase, Status, Update.

{% hint style="info" %}
**InstantBooking subset:** Returns `Code`, `Name`, `Type`, and `PdsUrl` only.
{% endhint %}

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="234.5244140625">Field</th><th width="150.257080078125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>Name</code></td><td>string</td><td>Product display name.</td></tr><tr><td><code>Code</code></td><td>string</td><td>Product code. Pass this as <code>PolicyCode</code> in the Purchase request.</td></tr><tr><td><code>Type</code></td><td>string</td><td>Product type.</td></tr><tr><td><code>Excess</code></td><td>float</td><td>Excess amount.</td></tr><tr><td><code>GapCoverAmount</code></td><td>float</td><td>Gap cover amount included in the product.</td></tr><tr><td><code>Inclusions</code></td><td>string</td><td>Product inclusions (HTML).</td></tr><tr><td><code>Description</code></td><td>string</td><td>Full product description (HTML).</td></tr><tr><td><code>SellingPoints</code></td><td>string</td><td>Key selling points (HTML).</td></tr><tr><td><code>PdsUrl</code></td><td>string</td><td>URL to the Product Disclosure Statement (PDS) PDF.</td></tr><tr><td><code>SupplierName</code></td><td>string</td><td>Insurer/supplier name.</td></tr><tr><td><code>ModifyUrl</code></td><td>string</td><td>URL to modify the policy on RentalCover.com (non-API).</td></tr><tr><td><code>CancelUrl</code></td><td>string</td><td>URL to cancel the protection on RentalCover.com (non-API).</td></tr><tr><td><code>ExpressCode</code></td><td>string</td><td><code>ExpressCode</code> from the request, if provided.</td></tr><tr><td><code>RoadsideAssistanceBlob</code></td><td>string</td><td>Roadside assistance instructions for CRM systems and email templates. Returned by Purchase only.</td></tr></tbody></table>

## Customer object

Returned by: Quote, InstantBooking, Purchase, Status, Update, UpdateCustomer.

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="234.7486572265625">Field</th><th width="150.0093994140625">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>CustomerId</code></td><td>integer</td><td>Internal RentalCover customer ID.</td></tr><tr><td><code>FirstName</code></td><td>string</td><td>Customer first name.</td></tr><tr><td><code>LastName</code></td><td>string</td><td>Customer last name.</td></tr><tr><td><code>Email</code></td><td>string</td><td>Customer email address.</td></tr><tr><td><code>Phone</code></td><td>string</td><td>Customer phone number.</td></tr><tr><td><code>Age</code></td><td>integer</td><td>Customer age.</td></tr><tr><td><code>DateOfBirth</code></td><td>string</td><td>Customer date of birth (<code>yyyy-mm-dd</code>), if provided.</td></tr><tr><td><code>Country</code></td><td>string</td><td>Customer country code (ISO 3166-1 alpha-2).</td></tr><tr><td><code>CountryId</code></td><td>integer</td><td>Internal country ID corresponding to <code>Country</code>.</td></tr><tr><td><code>Region</code></td><td>string</td><td>Customer state/region/territory code, if provided.</td></tr><tr><td><code>Address1</code></td><td>string</td><td>Customer street address line 1.</td></tr><tr><td><code>Address2</code></td><td>string</td><td>Customer street address line 2.</td></tr><tr><td><code>City</code></td><td>string</td><td>Customer city or suburb.</td></tr><tr><td><code>PostalCode</code></td><td>string</td><td>Customer postcode or zip code.</td></tr><tr><td><code>Coupons</code></td><td>object</td><td>Available coupons keyed by coupon code. Omitted if no coupons are available. See <a href="#customer-coupons">Customer Coupons</a> below.</td></tr></tbody></table>

## Customer coupons

The `Coupons` field within the Customer object is a JSON object keyed by coupon code:

```json
{
  "SUMMER10": {
    "Title": "Summer discount",
    "Value": 10,
    "ValueType": "percent",
    "AmountRemaining": 10.00,
    "EffectiveFrom": "2025-06-01 00:00:00",
    "EffectiveTo": "2025-08-31 23:59:59",
    "Terms": "Valid on bookings over 5 days."
  }
}
```

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="235.20458984375">Field</th><th width="150.2333984375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>Title</code></td><td>string</td><td>Display name of the coupon.</td></tr><tr><td><code>Value</code></td><td>float</td><td>Discount value.</td></tr><tr><td><code>ValueType</code></td><td>string</td><td>How the value is applied: <code>percent</code> or <code>amount</code>.</td></tr><tr><td><code>AmountRemaining</code></td><td>float</td><td>Remaining balance (for partial-use coupons).</td></tr><tr><td><code>EffectiveFrom</code></td><td>datetime</td><td>Date from which the coupon is valid.</td></tr><tr><td><code>EffectiveTo</code></td><td>datetime</td><td>Date on which the coupon expires.</td></tr><tr><td><code>Terms</code></td><td>string</td><td>Terms and conditions text.</td></tr></tbody></table>

## Commission object

Returned by: Quote, Purchase.

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="235.0670166015625">Field</th><th width="149.96435546875">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>TotalCommission</code></td><td>string</td><td>Partner commission amount (includes discounts and markups).</td></tr><tr><td><code>TotalCommissionFormatted</code></td><td>string</td><td>Formatted partner commission.</td></tr></tbody></table>

## SettlementCurrency object

Returned by: Quote. Contains the protection amount in the settlement currency agreed between the partner and RentalCover.

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="234.7962646484375">Field</th><th width="150.1148681640625">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>SettlementCurrency</code></td><td>string</td><td>Settlement currency code (ISO 4217).</td></tr><tr><td><code>SettlementAmount</code></td><td>float</td><td>Protection amount in the settlement currency.</td></tr></tbody></table>

## DestinationCountry object

**DestinationCountryObject**

Returned by: Quote and Status as DestinationCountryObject. Also returned by UpdateCustomer as the Country field, same structure.

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="235.0670166015625">Field</th><th width="149.94287109375">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>Code</code></td><td>string</td><td>ISO 3166-1 alpha-2 country code.</td></tr><tr><td><code>Name</code></td><td>string</td><td>Full country name.</td></tr><tr><td><code>PhoneCode</code></td><td>string</td><td>Country phone prefix.</td></tr></tbody></table>

## Booking responses

The canonical response shape returned by Quote, Purchase, Status, and Update. Purchase, Status, and Update each reference this object and document only the fields that differ.

```json
{
  "Reference":                "AB12-345C-INS",
  "BookingId":                12345,
  "SupplierReference":        "RC-POL-98765",
  "Status":                   "Received",
  "Expired":                  false,
  "FromDate":                 "2025-08-01 00:00:00",
  "ToDate":                   "2025-08-08 00:00:00",
  "CoveredDays":              7,
  "TotalAmount":              45.00,
  "TotalAmountFormatted":     "US$45.00",
  "InsuranceCoverAmount":     3000.00,
  "InsuranceCoverAmountFormatted": "US$3,000.00",
  "DailyAmountFormatted":     "US$6.43",
  "DiscountFormatted":        "US$0.00",
  "Currency":                 "USD",
  "DestinationCountry":       "Ireland",
  "VehiclePickupRegion":      "",
  "QuoteUrl":                 "https://rentalcover.com/...",
  "PoweredByLogo":            "https://...",
  "Documentation": { "Ipid": "https://..." },
  "Disclaimer":               "...",
  "EsimCouponEligible":       "false",
  "Policy":                   { ... },
  "Customer":                 { ... },
  "Commission":               { ... },
  "SettlementCurrencyObject": { ... },
  "DestinationCountryObject": { ... }
}
```

### Scalar fields

<table data-header-hidden="false" data-header-sticky><thead><tr><th width="235.069580078125">Field</th><th width="151.3917236328125">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>Reference</code></td><td>string</td><td>Unique booking reference ending in <code>-INS</code>. Use this in all subsequent calls. Customers receive this in their confirmation email.</td></tr><tr><td><code>BookingId</code></td><td>integer</td><td>Internal booking ID (primary key).</td></tr><tr><td><code>SupplierReference</code></td><td>string</td><td>The insurer's own policy reference. Populated after the policy is confirmed with the underwriter.</td></tr><tr><td><code>Status</code></td><td>string</td><td>Current booking status. See <a href="https://docs.google.com/document/d/1ivu-Eknbpw9WESHc0Q0s-kUylfRtrV0s-G9S89I8wEg/edit#43-booking-statuses">Booking Statuses</a>.</td></tr><tr><td><code>Expired</code></td><td>boolean</td><td>Whether the quote has expired.</td></tr><tr><td><code>FromDate</code></td><td>datetime</td><td>Protection start date/time.</td></tr><tr><td><code>ToDate</code></td><td>datetime</td><td>Protection end date/time.</td></tr><tr><td><code>CoveredDays</code></td><td>integer</td><td>Number of days the customer is covered.</td></tr><tr><td><code>TotalAmount</code></td><td>float</td><td>Total premium the customer pays (includes discounts and markups).</td></tr><tr><td><code>TotalAmountFormatted</code></td><td>string</td><td>Formatted <code>TotalAmount</code>.</td></tr><tr><td><code>InsuranceCoverAmount</code></td><td>float</td><td>Total amount of coverage the product provides.</td></tr><tr><td><code>InsuranceCoverAmountFormatted</code></td><td>string</td><td>Formatted <code>InsuranceCoverAmount</code>.</td></tr><tr><td><code>DailyAmountFormatted</code></td><td>string</td><td>TotalAmount divided by <code>CoveredDays</code>, formatted.</td></tr><tr><td><code>DiscountFormatted</code></td><td>string</td><td>Discount applied, formatted.</td></tr><tr><td><code>Currency</code></td><td>string(3)</td><td>ISO 4217 currency code for the booking.</td></tr><tr><td><code>DestinationCountry</code></td><td>string</td><td>Full name of the destination country.</td></tr><tr><td><code>VehiclePickupRegion</code></td><td>string</td><td>State/region/territory code for the vehicle pickup location, echoed from the request.</td></tr><tr><td><code>QuoteUrl</code></td><td>string</td><td>URL to the payment page on RentalCover.com. Embed in confirmation emails for customers who decline at checkout.</td></tr><tr><td><code>PoweredByLogo</code></td><td>string</td><td>URL of the RentalCover "Powered By" logo.</td></tr><tr><td><code>Documentation.Ipid</code></td><td>string</td><td>URL to the Insurance Product Information Document (IPID). Returned only when applicable.</td></tr><tr><td><code>Disclaimer</code></td><td>string</td><td>Policy disclaimer text to display to the customer.</td></tr><tr><td><code>EsimCouponEligible</code></td><td>string</td><td><code>true</code> if the partner and destination are eligible for an eSIM coupon.</td></tr></tbody></table>

### Nested objects

<table data-header-hidden="false" data-header-sticky><thead><tr><th>Field</th><th>Object type</th><th>Reference</th></tr></thead><tbody><tr><td>Policy</td><td>Policy object</td><td>See <a href="#policy-object">Policy object</a>.</td></tr><tr><td>Customer</td><td>Customer object</td><td>See <a href="#customer-object">Customer object</a>.</td></tr><tr><td>Commission</td><td>Commission object</td><td>See <a href="#commission-object">Commission object</a>.</td></tr><tr><td>SettlementCurrency</td><td>SettlementCurrency object</td><td>See <a href="#settlementcurrency-object">SettlementCurrency object</a>.</td></tr><tr><td>DestinationCountry</td><td>DestinationCountry object</td><td>See <a href="#destinationcountry-object">DestinationCountry object</a>.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://partner-docs.covergenius.com/rentalcover/shared-reference/response-objects.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.