> ## Documentation Index
> Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 `referenceId`s
from the company's field configuration. Use the
[Get Entity Configuration](/api-reference/entities/overview#configuration-discovery)
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](/api-reference/entities/overview#permissions).




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/entities/{entityType}
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/entities/{entityType}:
    post:
      tags:
        - Entities
      summary: Create Entity
      description: >
        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
        `referenceId`s

        from the company's field configuration. Use the

        [Get Entity
        Configuration](/api-reference/entities/overview#configuration-discovery)

        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](/api-reference/entities/overview#permissions).
      operationId: createEntity
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/crudEntityType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
              description: Flat JSON object with field referenceIds as keys
            examples:
              basic:
                summary: Create with required fields
                value:
                  exposureName: Acme Corp HQ
                  exposureType: company
      responses:
        '201':
          description: Entity created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: The ID of the created entity
              examples:
                success:
                  summary: Entity created
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440301
        '400':
          description: Bad Request - Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missingRequiredField:
                  summary: Missing required field
                  value:
                    error:
                      code: InvalidEntityShape
                      message: 'fieldModelV1Data: ''exposureType'' is required but null'
                      userMessages:
                        - '''exposureType'' is required but null'
                      details:
                        - field: fieldModelV1Data
                          message: '''exposureType'' is required but null'
                invalidOptionSet:
                  summary: Invalid option set value
                  value:
                    error:
                      code: InvalidFieldModelV1Data
                      message: >-
                        fieldModelV1Data: Field 'exposureType' value 'Bad Value'
                        is not a valid option. Valid options: person, company
                      userMessages:
                        - >-
                          Field 'exposureType' value 'Bad Value' is not a valid
                          option. Valid options: person, company
                      details:
                        - field: fieldModelV1Data
                          message: >-
                            Field 'exposureType' value 'Bad Value' is not a
                            valid option. Valid options: person, company
                invalidEntityType:
                  summary: Unsupported entity type
                  value:
                    error:
                      code: INVALID_ENTITY_TYPE
                      message: Invalid entity type. Must be a configured entity.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    crudEntityType:
      name: entityType
      in: path
      required: true
      schema:
        type: string
        enum:
          - event
          - exposure
          - quote
          - submission
          - person
          - organization
      description: >
        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.
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        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.

````