Skip to main content
GET
/
api
/
v1
/
external
/
companies
/
{companyId}
/
submissions
/
configuration
Get Submissions Configuration
curl --request GET \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/submissions/configuration \
  --header 'Authorization: <api-key>'
{
  "fields": {
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "properties": {
      "brokerName": {
        "type": "string",
        "title": "brokerName"
      },
      "lineOfBusiness": {
        "type": "string",
        "title": "lineOfBusiness",
        "oneOf": [
          {
            "const": "generalLiability",
            "title": "General Liability"
          },
          {
            "const": "workersComp",
            "title": "Workers Comp"
          }
        ]
      }
    },
    "required": []
  }
}

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 submission custom fields

Configuration response for Field Model V1 submissions. Returns a JSON Schema describing the custom fields available for creating or updating submissions. The schema excludes calculated fields, server-populated fields, and lifecycle fields (submissionStatus, submissionType, submissionNumber, submissionName, submissionPrimaryInsured, submissionBoundDate, submissionQuotes).

​
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.