Get Entity Configuration

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
    ]
  }
}

Entities

Get Entity Configuration

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

Policy is separately owned and has its own Get Policy Configuration endpoint (/policies/configuration); policy is not accepted here.

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 is exactly the set of fields you must supply when CREATING the entity — the platform’s structural requirements minus everything the write path produces for you (join fields, calculated fields, server-seeded defaults). Supply all of them and the create cannot be rejected for missing input; omit any and the create is rejected with a single InvalidEntityShape 400 naming every field it missed. Requiredness does not apply to PATCH, which merges only the fields you send. 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
Person: company.fmv1_custom_object:read
Organization: company.fmv1_custom_object:read

GET

api

companies

{companyId}

entities

{entityType}

configuration

Get Entity Configuration

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/entities/{entityType}/configuration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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 CRUD entity type (lowercase kebab-case URL slug). Policy is separately owned and has its own configuration endpoint (/policies/configuration); it is not a valid value here.

Available options:

event,

exposure,

quote,

submission,

person,

organization

Response

Configuration for the entity's fields

Configuration response for a Field Model V1 entity (Event, Exposure, Quote, Submission, Person, Organization, or read-only Policy). 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

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Get Entity Configuration

Authorizations

Path Parameters

Response