Planned — Submission endpoints are being added to the v1 API. See the Roadmap for overall API direction.
Key Concepts
- Submission — a container that groups one or more quotes. Each submission has a type that describes its purpose.
- Submission types —
quote(new business),renewal,endorsement,cancellation,reinstatement - Quote association — quotes are linked to a submission via
submissionIdwhen creating the quote
Planned Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/submissions | Create a submission |
| GET | /v1/submissions | List submissions |
| GET | /v1/submissions/{submissionId} | Get a submission |
| PUT | /v1/submissions/{submissionId} | Update a submission |
| DELETE | /v1/submissions/{submissionId} | Delete a submission |
Workflow
- Create a submission — specify the type and any metadata
- 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
Permissions
| Operation | Permission |
|---|---|
| List, Get | company.submission:read |
| Create | company.submission:create |
| Update | company.submission:update |
| Delete | company.submission:delete |
Related Resources
- Quotes API — create and manage quotes within a submission
- Policy API — bind quotes to create policies
- Roadmap — overall API direction
