Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aiinsurance.io/llms.txt

Use this file to discover all available pages before exploring further.

A submission groups related quotes for a single applicant. It serves as the entry point for new business, renewals, endorsements, cancellations, and reinstatements.

​
Key Concepts

  • Submission — a container that groups one or more quotes. Each submission has a type that describes its purpose.
  • Submission types — newBusiness, renewal, endorsement, cancellation, reinstatement
  • Quote association — quotes are linked to a submission via submissionId when creating the quote. The submissionQuotes join field on the submission response contains the linked quote IDs.

​
API Endpoints

MethodEndpointDescription
POST/v1/submissionsCreate a submission
GET/v1/submissionsList submissions (filterable by type, status, text)
GET/v1/submissions/{submissionId}Get a submission
PUT/v1/submissions/{submissionId}Update a submission
DELETE/v1/submissions/{submissionId}Soft-delete a submission
GET/v1/submissions/configurationGet available fields schema

​
Data Model

Submissions use fieldModelV1Data — a flat JSON object where keys are field reference IDs. System-managed fields include:
FieldDescription
submissionNumberAuto-generated submission number
submissionTypeSubmission type (required on create)
submissionStatusCurrent status (defaults to inProgress)
submissionNameDisplay name
submissionPrimaryInsuredPrimary insured name (set from first quote’s primary exposure)
submissionBoundDateDate when the submission’s quote was bound
submissionQuotesArray of linked quote IDs (populated via join field)
Use the Configuration endpoint to discover all available fields including custom fields defined in the onboarding spreadsheet.

​
Workflow

  1. Create a submission — specify the submissionType and any custom fields
  2. Create quotes under the submission using POST /v1/quotes with the submissionId field
  3. Iterate on quotes — update, rate, and refine
  4. Bind the accepted quote — converts to a policy via the Policy Transaction API. The submission status is automatically updated to boundToPolicy.

​
Permissions

OperationPermission
List, Get, Configurationcompany.submission:read
Createcompany.submission:create
Updatecompany.quote:update
Deletecompany.quote:delete
Update and Delete currently use company.quote:update and company.quote:delete permissions because dedicated company.submission:update and company.submission:delete permissions have not been created yet.
  • Quotes API — create and manage quotes within a submission
  • Policy API — bind quotes to create policies