Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
configuration
/
rating
/
form-logic
List Rating Revision Form Logic
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": "bc6a626e-7a96-49fd-b477-2b18cf189a0d",
      "ruleName": "Attach Certificate of Insurance",
      "rank": 1,
      "step": "policies",
      "shouldAdd": {
        "leftKey": "form.number",
        "operator": "=",
        "rightValue": "FM-0001"
      }
    },
    {
      "id": "7dc1e6fa-9f03-4b81-8f36-ee9fb5b5fde5",
      "ruleName": "Attach state-specific endorsement",
      "rank": 2,
      "step": [
        "policies",
        "quotes"
      ],
      "shouldAdd": {
        "operator": "AND",
        "conditions": [
          {
            "leftKey": "form.number",
            "operator": "=",
            "rightValue": "FM-0002"
          },
          {
            "leftKey": "policy.data.state",
            "operator": "=",
            "rightValue": "CA"
          }
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Query Parameters

​
ratingEngineRevisionId
string<uuid>
required

The rating engine revision ID (must exist and belong to the company)

​
ruleName
string

Filter to rules whose ruleName matches exactly. Must be non-empty when provided.

Minimum string length: 1
​
id

Filter to a single rule ID or an array of rule IDs

​
sortBy
enum<string>
default:ruleName

Field to sort by (default ruleName)

Available options:
ruleName,
rank
​
sortDirection
enum<string>
default:asc

Sort direction (default asc)

Available options:
asc,
desc

Response

List of form-logic rules

​
items
object[]
required