Skip to main content
Submission is a top-level Field Model V1 entity, managed through the unified entity CRUD endpoints at /api/v1/external/companies/{companyId}/entities/Submission. A submission groups related quotes for a single applicant and serves as the entry point for new business, renewals, endorsements, cancellations, and reinstatements. Like all FMV1 entities, the set of available fields is configured per company. Key Concepts:
  • The request body for create and update is a flat JSON object where keys are field referenceIds (e.g., submissionType, submissionName).
  • Responses use the generic entity envelope — all field values live inside a fieldModelV1Data object, alongside id, createdAt/createdBy, updatedAt/updatedBy, and resolved createdByName/updatedByName. There is no top-level companyId.
  • Updates use merge semantics — provided fields are merged onto the existing data, a key set to null clears that field, and omitted fields are left unchanged. PUT is accepted as an alias for PATCH.
  • Get returns the submission’s own data only — there is no cross-entity enrichment. Linked quotes are not embedded; query them separately.

​
Framework-Required Fields

These fields are required by the framework on create:
FieldDescription
submissionNumberSubmission number. Resolver-populated calculated value.
submissionTypeSubmission type (e.g. new business, renewal, endorsement, cancellation, reinstatement)
submissionStatusCurrent status. Resolver-populated calculated value.
referencedExposuresFlat list of referenced Exposure ids. Calculated Join field, recomputed on every write — see Referenced Exposures.
Because submissionNumber, submissionStatus, and referencedExposures are resolver-populated calculated values, a create request only needs submissionType (plus any required custom fields). Discover the full set of available fields, including custom fields defined in the onboarding spreadsheet, via the Configuration endpoint.
The unified list endpoint supports free-text search via filterText, which matches against submissionNumber and submissionName. Pagination is zero-based pageNumber (default 0) with pageSize (default 51); sort via sortBy (any configured field, default createdAt) and sortDirection. The list response is { items: [...envelope...], hasMore, totalCount }.

​
Configuration

Configuration discovery uses the unified entity configuration endpoint. Call GET /api/v1/external/companies/{companyId}/entities/submission/configuration to retrieve a JSON Schema of the available submission fields for your company.

​
Workflow

  1. Create a submission — specify the submissionType and any custom fields.
  2. Create quotes under the submission, linking each quote to the submission.
  3. Iterate on quotes — update, rate, and refine.
  4. Create the policy from the accepted quote via the Policy Transaction API.

​
Permissions

OperationPermission
Get Configurationcompany.submission:read
List / Getcompany.submission:read
Createcompany.submission:create
Updatecompany.submission:update
Deletecompany.submission:delete

​
Example Create Request

{
  "submissionType": "newBusiness",
  "submissionName": "Acme Corporation - 2025"
}

​
Example Response

{
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "fieldModelV1Data": {
    "submissionNumber": "S-2025-001",
    "submissionType": "newBusiness",
    "submissionStatus": "inProgress",
    "submissionName": "Acme Corporation - 2025"
  },
  "createdAt": 1736937000,
  "createdBy": "google-oauth2|123456789",
  "updatedAt": 1736937000,
  "updatedBy": null,
  "createdByName": "Jane Doe",
  "updatedByName": null
}
createdAt and updatedAt are epoch-second integers, not ISO strings.
  • Quotes API — create and manage quotes within a submission
  • Policy API — create policies via the transaction model