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
submissionIdwhen creating the quote. ThesubmissionQuotesjoin field on the submission response contains the linked quote IDs.
API Endpoints
Data Model
Submissions usefieldModelV1Data — a flat JSON object where keys are field reference IDs. System-managed fields include:
Use the Configuration endpoint to discover all available fields including custom fields defined in the onboarding spreadsheet.
Workflow
- Create a submission — specify the
submissionTypeand any custom fields - Create quotes under the submission using
POST /v1/quoteswith thesubmissionIdfield - Iterate on quotes — update, rate, and refine
- Bind the accepted quote — converts to a policy via the Policy Transaction API. The submission status is automatically updated to
boundToPolicy.
Permissions
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.Related Resources
- Quotes API — create and manage quotes within a submission
- Policy API — bind quotes to create policies
