Changelog
Back to All
added

Coverage Rules Endpoints

2 months ago by Root Insurance

Retrieves coverage rules, which describes the allowed combinations of coverage selections, for an existing quote or a state abbreviation. For example, in some states (but not all) Rental coverage requires both Collision and Comprehensive coverages to be selected (if either are declined, Rental coverage must also be declined in that scenario).

/v3/quoting/quote/{quote_id}/coverages/rules Get coverage rules

/v3/quoting/market/{state}/coverages/rules Get coverage rules by state

Released: [2025-01-10]

These two endpoints allow for the retrieval of coverage rules based on the current state of an existing quote or a state abbreviation.

The returned ruletree describes rules for how coverages interact with each other when customizing coverages (for example, in some states, Rental coverage can only be selected if Collision and Comprehensive coverages have also been selected). To learn all about how to use the coverage rule response, please checkout our guide.


Get coverage rules

Key Features

  • Quote ID: Accepts a quote ID in the input path of an existing quote for which to get coverage rules.
  • Data Retrieval: Returns a JSON payload with a key of coverageRules containing the coverage rules based on the quote ID provided.

Error Handling

  • [Get coverage rules]: If the quote id is invalid, the endpoint returns a 404 Not Found response with an error message "Invalid quote ID: <quote_id>".

Usage Example

GET /v3/quoting/quote/{quote_id}/coverages/rules
Content-Type: application/json

Get coverage rules by state

Key Features

  • State Abbreviation: Accepts a state abbreviation, like OH, for which to get coverage rules.
  • Data Retrieval: Returns a JSON payload with a key of coverageRules containing the coverage rules based on the provided state.

Error Handling

  • [Get coverage rules by state]: If the provided state abbreviation is invalid, the endpoint returns a 422 Unprocessable Content response with an error message invalid_market.

Usage Example

GET /v3/quoting/market/{state}/coverages/rules
Content-Type: application/json

Sample Response Snippet (OH)

{
  "coll": {
    "selected": [
      {
        "description": "Vehicles must have either both Comprehensive and Collision coverage, or neither",
        "acceptableConditions": [
          {
            "comp": "selected"
          }
        ]
      },
      {
        "description": "Uninsured Motorist Property Damage cannot be selected if Collision has been selected",
        "acceptableConditions": [
            {
                "umpd": "declined"
            }
        ]
      }
    ],
    "declined": [
      {
        "description": "Vehicles must have either both Comprehensive and Collision coverage, or neither",
        "acceptableConditions": [
          {
            "comp": "declined"
          }
        ]
      },
      {
          "description": "Rental cannot be selected if Collision or Comprehensive has been declined",
          "acceptableConditions": [
              {
                  "rental": "declined"
              }
          ]
      }
    ],
  },
  "comp": {
    "selected": [
      {
        "description": "Vehicles must have either both Comprehensive and Collision coverage, or neither",
        "acceptableConditions": [
          {
            "coll": "selected"
          }
        ]
      }
    ],
    "declined": [
      {
        "description": "Vehicles must have either both Comprehensive and Collision coverage, or neither",
        "acceptableConditions": [
          {
            "coll": "declined"
          }
        ]
      },
      {
        "description": "Rental cannot be selected if Collision or Comprehensive has been declined",
        "acceptableConditions": [
          {
            "rental": "declined"
          }
        ]
      }
    ]
  },
  "rental": {
    "selected": [
      {
        "description": "Rental cannot be selected if Collision or Comprehensive has been declined",
        "acceptableConditions": [
          {
            "coll": "selected",
            "comp": "selected"
          }
        ]
      }
    ]
  }
}