Get Entity Configuration

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/entities/{entityType}/configuration \
  --header 'Authorization: <api-key>'

{
  "fields": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "exposureName": {
        "type": "string",
        "title": "exposureName"
      },
      "exposureType": {
        "type": "string",
        "title": "exposureType"
      },
      "numberOfEmployees": {
        "type": "number",
        "title": "numberOfEmployees"
      },
      "riskLevel": {
        "type": "string",
        "title": "riskLevel",
        "oneOf": [
          {
            "const": "low",
            "title": "Low"
          },
          {
            "const": "medium",
            "title": "Medium"
          },
          {
            "const": "high",
            "title": "High"
          }
        ]
      },
      "riskScore": {
        "type": "number",
        "title": "riskScore",
        "readOnly": true,
        "x-calculated": true
      }
    },
    "required": [
      "exposureName",
      "exposureType"
    ]
  }
}

Exposures

Get Entity Configuration

Returns a JSON Schema describing the fields available for creating or updating a Field Model V1 entity. The entityType path parameter is the lowercase kebab-case entity slug (event, exposure, quote, submission, or policy).

The fields schema is a standard JSON Schema (draft 2020-12) that can be used directly with validation libraries like Ajv or Zod. The required array lists fields that must be provided when creating or updating the entity. For entities that embed exposures (Quote), the embedded exposure schema is nested under its join field (e.g. exposures).

Calculated (JEXL-derived) and other server-managed fields — e.g. quoteNumber, quoteStatus, policyPremium — are included in the schema (so they are discoverable and overridable) but annotated with readOnly: true and x-calculated: true so consumers can tell them apart from ordinary inputs. The write path still accepts these fields; the calculated expression decides whether a supplied value is honored or recomputed, so the annotation means “server-managed”, not “rejected on write”. This annotation is applied uniformly across every entity type.

Required permissions (per entity type):

Event: company.event:export
Exposure: company.insured:read
Quote: company.quote:read
Submission: company.submission:read
Policy: company.policy:read

GET

api

external

companies

{companyId}

entities

{entityType}

configuration

Get Entity Configuration

curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/entities/{entityType}/configuration \
  --header 'Authorization: <api-key>'

{
  "fields": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "exposureName": {
        "type": "string",
        "title": "exposureName"
      },
      "exposureType": {
        "type": "string",
        "title": "exposureType"
      },
      "numberOfEmployees": {
        "type": "number",
        "title": "numberOfEmployees"
      },
      "riskLevel": {
        "type": "string",
        "title": "riskLevel",
        "oneOf": [
          {
            "const": "low",
            "title": "Low"
          },
          {
            "const": "medium",
            "title": "Medium"
          },
          {
            "const": "high",
            "title": "High"
          }
        ]
      },
      "riskScore": {
        "type": "number",
        "title": "riskScore",
        "readOnly": true,
        "x-calculated": true
      }
    },
    "required": [
      "exposureName",
      "exposureType"
    ]
  }
}

Authorizations

Authorization

string

header

required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId

string<uuid>

required

Company identifier

entityType

enum<string>

required

Field Model V1 entity type (lowercase kebab-case URL slug)

Available options:

event,

exposure,

quote,

submission,

policy,

person,

organization

Response

Configuration for the entity's fields

Configuration response for a Field Model V1 entity (Event, Exposure, Quote, or Submission). Returns a JSON Schema describing the fields available for creating or updating that entity. For entities that embed exposures (Quote), the embedded exposure schema is nested under the corresponding join field (e.g. exposures) rather than returned as a separate top-level key.

fields

object

required

Standard JSON Schema (draft 2020-12) describing field definitions for Field Model V1 entities. Includes a required array listing fields that must be provided.

Show child attributes

Overview Create Exposure

⌘I