Create Entity

curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/entities/{entityType} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exposureName": "Acme Corp HQ",
  "exposureType": "company"
}
'

{
  "id": "550e8400-e29b-41d4-a716-446655440301"
}

Entities

Create Entity

Creates a top-level Field Model V1 entity of {entityType} via the unified entity CRUD pipeline. One parametric endpoint serves all six CRUD entity types — event, exposure, quote, submission, person, organization.

The request body is a flat JSON object whose keys are field referenceIds from the company’s field configuration. Use the Get Entity Configuration endpoint to discover the available fields for the type and which are required.

The pipeline validates the data (option sets, types, join cardinality), resolves calculated/auto-set values, enforces framework-required fields, inserts, then syncs join relationships. Date fields are objects: { "date": "YYYY-MM-DD", "timezone": "America/New_York" }.

Required permission: company.{entity}:create — the exact key varies by type (e.g. company.insured:create for Exposure, company.fmv1_custom_object:create for Person/Organization). See Permissions.

POST

api

external

companies

{companyId}

entities

{entityType}

Create Entity

curl --request POST \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/entities/{entityType} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exposureName": "Acme Corp HQ",
  "exposureType": "company"
}
'

{
  "id": "550e8400-e29b-41d4-a716-446655440301"
}

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). One of the six CRUD entity types: event, exposure, quote, submission, person, organization. policy is NOT valid here — Policy has no generic CRUD (its writes go through the policy transaction endpoints), though it does have a read-only /configuration schema.

Available options:

event,

exposure,

quote,

submission,

person,

organization

Body

application/json

Flat JSON object with field referenceIds as keys

Response

Entity created successfully

string<uuid>

The ID of the created entity

Get Entity Configuration List Entities

⌘I