Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
quotes
/
configuration
Get Quotes Configuration
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration \
  --header 'Authorization: <api-key>'
{
  "policyInfo": {
    "data": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "policyDescription": {
          "type": "string",
          "title": "Policy Description"
        },
        "effectiveDate": {
          "type": "string",
          "title": "Effective Date",
          "format": "date"
        },
        "contactEmail": {
          "type": "string",
          "title": "Contact Email",
          "format": "email"
        },
        "premium": {
          "type": "number",
          "title": "Annual Premium",
          "format": "currency"
        },
        "coverageTerritory": {
          "type": "string",
          "title": "Coverage Territory",
          "oneOf": [
            {
              "const": "domestic",
              "title": "Domestic"
            },
            {
              "const": "worldwide",
              "title": "Worldwide"
            },
            {
              "const": "north_america",
              "title": "North America"
            }
          ]
        }
      }
    }
  },
  "exposureTypes": [
    {
      "value": "vehicle",
      "label": "Vehicle"
    },
    {
      "value": "property",
      "label": "Property"
    },
    {
      "value": "employee",
      "label": "Employee"
    }
  ],
  "exposureRatingFields": {
    "vehicle": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "vin": {
          "type": "string",
          "title": "VIN"
        },
        "make": {
          "type": "string",
          "title": "Make"
        },
        "model": {
          "type": "string",
          "title": "Model"
        },
        "year": {
          "type": "integer",
          "title": "Year"
        }
      }
    },
    "property": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "address": {
          "type": "string",
          "title": "Property Address"
        },
        "squareFootage": {
          "type": "number",
          "title": "Square Footage"
        },
        "constructionType": {
          "type": "string",
          "title": "Construction Type",
          "oneOf": [
            {
              "const": "frame",
              "title": "Frame"
            },
            {
              "const": "masonry",
              "title": "Masonry"
            },
            {
              "const": "steel",
              "title": "Steel"
            }
          ]
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Response

Configuration for quote custom fields

Configuration response for quotes. Structure mirrors the quote request/response shape so consumers can see exactly where to use each schema when creating or updating quotes.

​
policyInfo
object
required
​
exposureTypes
object[]
required

Available exposure types for this company

​
exposureRatingFields
object
required

JSON Schema for rating fields per exposure type. Keys are exposure type values, values are JSON Schema objects.