---
title: "Coverage text"
description: "The coverage bullets the widget shows for a category, with and without a priced store category."
---

Every quote carries its coverage bullets in `coverageV1`. When you need the text before you have a quote, for example on a category landing page, a comparison table or a product page where the price is not yet known, use these two endpoints. Both are read-only and need no authentication.

| Endpoint | Returns |
|----------|---------|
| `GET /quote/api/insurerCategory/listCoverageOptions` | The bullets of the one coverage type your store offers for a category |
| `GET /quote/api/insurerCategory/listProductCoverage` | Every coverage type the category can carry on your store, with bullets and plan terms, even before the category is priced |

## Coverage options for a category

`GET https://{HOST_NAME}/quote/api/insurerCategory/listCoverageOptions`

<ParamField query="storeId" type="string" required>
  Your store identifier.
</ParamField>
<ParamField query="sbCategoryId" type="string" required>
  The SureBright category (from [List Category](/api-reference/endpoint/store-category/list-category) or a quote).
</ParamField>
<ParamField query="platform" type="string">
  Default `SHOPIFY`.
</ParamField>

```bash
curl 'https://{HOST_NAME}/quote/api/insurerCategory/listCoverageOptions?storeId=example-store.myshopify.com&sbCategoryId=2b7e4f10-9c3a-4d5e-8f61-7a2b3c4d5e6f'
```

### Response

<ResponseField name="isError" type="boolean">
  `false` on success.
</ResponseField>
<ResponseField name="coverageType" type="string">
  `AD` (accidental damage), `B` (breakdown) or `AB` (both).
</ResponseField>
<ResponseField name="coverageList" type="object[]">
  <Expandable title="fields">
    <ResponseField name="info" type="string">
      Bullet text for the inline widget. May contain `<br>` line breaks.
    </ResponseField>
    <ResponseField name="popup" type="string">
      Bullet text for the details popup.
    </ResponseField>
    <ResponseField name="MOBILE_INFO" type="string">
      Shorter text for small screens, when provided.
    </ResponseField>
    <ResponseField name="QUICK_VIEW_INFO" type="string">
      Text for the quick-view card, when provided.
    </ResponseField>
    <ResponseField name="optionType" type="string">
      `COVERAGE_OPTION` for what the plan covers, `WHY_SUREBRIGHT_OPTION` for service promises (claims, cancellation, support).
    </ResponseField>
    <ResponseField name="iconType" type="string">
      Icon key the widget maps to its icon set, or `null`.
    </ResponseField>
    <ResponseField name="iconImageUrl" type="string">
      A ready-made icon image chosen from the bullet text, or an empty string.
    </ResponseField>
  </Expandable>
</ResponseField>

### Errors

| Code | Body | Meaning |
|------|------|---------|
| `400` | `{"isError": true, "message": "Insufficient params"}` | `storeId` or `sbCategoryId` missing |
| `500` | `{"isError": true, "message": "Internal server error"}` | The store does not offer this category on this platform, or no coverage text is configured for it |

## Product coverage for a category

`GET https://{HOST_NAME}/quote/api/insurerCategory/listProductCoverage`

Answers "what protection can this product carry here" from the product's SureBright category alone. It works for a store whose categories are not priced yet, so **By Product** would return no plans, and it can classify a product URL for you when you do not have the category.

<ParamField query="storeId" type="string" required>
  Your store identifier.
</ParamField>
<ParamField query="sbCategoryId" type="string">
  The SureBright category. Required unless `base64ProductURL` is sent.
</ParamField>
<ParamField query="base64ProductURL" type="string">
  A product page URL, Base64-encoded. SureBright classifies it first and uses the resulting category. See [Categorize a product](/api-reference/endpoint/product-category/categorize).
</ParamField>
<ParamField query="platform" type="string">
  Default `SHOPIFY`.
</ParamField>
<ParamField query="country" type="string">
  `US` or `CA`. Limits the answer to what the store offers in that country.
</ParamField>

```bash
curl 'https://{HOST_NAME}/quote/api/insurerCategory/listProductCoverage?storeId=example-store.myshopify.com&sbCategoryId=2b7e4f10-9c3a-4d5e-8f61-7a2b3c4d5e6f&country=US'
```

### Response

<ResponseField name="isError" type="boolean">
  `false` on success.
</ResponseField>
<ResponseField name="sbCategoryId" type="string">
  The category answered for (the classified one when you sent a URL).
</ResponseField>
<ResponseField name="categoryName" type="string">
  Its name, or `null` when the store does not offer it.
</ResponseField>
<ResponseField name="isStoreCategoryRequired" type="boolean">
  Always `false`: this answer does not depend on a priced store category.
</ResponseField>
<ResponseField name="coverageTypeList" type="object[]">
  One entry per coverage type the store offers for the category. Empty when it offers none.
  <Expandable title="fields">
    <ResponseField name="coverageType" type="string">
      `AD`, `B` or `AB`.
    </ResponseField>
    <ResponseField name="optionList" type="object[]">
      Bullets, `{info, iconImageUrl}`, deduplicated by text.
    </ResponseField>
    <ResponseField name="tenureList" type="number[]">
      The plan terms offered, in years, ascending.
    </ResponseField>
  </Expandable>
</ResponseField>

### Errors

| Code | Body | Meaning |
|------|------|---------|
| `400` | `{"isError": true, "message": "Insufficient params: storeId and sbCategoryId (or base64ProductURL)"}` | Missing inputs, or the URL could not be classified |
| `404` | `{"isError": true, "message": "No active coverage for this category on this store"}` | The lookup failed |
| `500` | `{"isError": true, "message": "Internal server error"}` | Unexpected failure |
