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

# Start an underwriting submission

> Create a submission for a managed product and an agency account (the insured) in `scope`. `status` defaults to `received`. The submission has no file yet: open one with `openUwSubmissionFile`. Requires edit access to the scope; the product and agency account must be readable there. Not idempotent: titles are not unique, so after an uncertain response list submissions before retrying.



## OpenAPI

````yaml /openapi.json post /insurance/uw-submissions
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/uw-submissions:
    post:
      tags:
        - Underwriting
      summary: Start an underwriting submission
      description: >-
        Create a submission for a managed product and an agency account (the
        insured) in `scope`. `status` defaults to `received`. The submission has
        no file yet: open one with `openUwSubmissionFile`. Requires edit access
        to the scope; the product and agency account must be readable there. Not
        idempotent: titles are not unique, so after an uncertain response list
        submissions before retrying.
      operationId: createUwSubmission
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2UwSubmissionCreate'
      responses:
        '201':
          description: The new submission, with no file yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2UwSubmission'
        '400':
          description: >-
            Invalid request, or guidelines or an input the guidelines cannot
            use; `details` lists each problem. Restart a list after
            `invalid_cursor`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Credential or scope access denied, or the change is not permitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Scope, product, guidelines, submission, file or input not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            The resource changed or already exists: read it again before
            retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: Content-Type must be application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Temporarily unavailable. Honor Retry-After in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2UwSubmissionCreate:
      type: object
      properties:
        scope:
          type: string
          pattern: ^mc:[A-Za-z0-9][A-Za-z0-9-]{0,127}$
          description: Authorization scope UUID or stable slug prefixed with mc:.
        productId:
          type: string
          format: uuid
          description: The managed product the submission is for.
        agencyAccountId:
          type: string
          format: uuid
          description: The agency account (the insured) in the same scope.
        title:
          type: string
          minLength: 1
          maxLength: 500
        status:
          type: string
          enum:
            - draft
            - received
            - in_review
            - needs_information
            - accepted_for_quoting
            - declined
            - withdrawn
          default: received
        submissionReference:
          type: string
          minLength: 1
          maxLength: 200
        businessType:
          type: string
          enum:
            - new
            - renewal
        requestedEffectiveDate:
          type: string
          format: date
        requestedExpirationDate:
          type: string
          format: date
        receivedAt:
          type: string
          format: date-time
        agencyMessage:
          type: string
          maxLength: 20000
        description:
          type: string
          maxLength: 20000
      required:
        - scope
        - productId
        - agencyAccountId
        - title
      additionalProperties: false
    V2UwSubmission:
      allOf:
        - $ref: '#/components/schemas/V2UwSubmissionSummary'
        - type: object
          properties:
            guidelines:
              $ref: '#/components/schemas/V2UwGuidelinesVersion'
          required:
            - guidelines
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2UwSubmissionSummary:
      type: object
      properties:
        id:
          type: string
          description: Stable submission ID.
        title:
          type: string
        status:
          type: string
          enum:
            - draft
            - received
            - in_review
            - needs_information
            - accepted_for_quoting
            - declined
            - withdrawn
        productId:
          type: string
          nullable: true
          description: The managed product. Null until one is chosen; a file needs it.
        agencyAccountId:
          type: string
          description: The agency account, which is the insured.
        submissionReference:
          type: string
          nullable: true
          description: The agency's own reference, if any.
        businessType:
          type: string
          nullable: true
          enum:
            - new
            - renewal
            - null
        requestedEffectiveDate:
          type: string
          nullable: true
          format: date
        requestedExpirationDate:
          type: string
          nullable: true
          format: date
        receivedAt:
          type: string
          nullable: true
          format: date-time
        agencyMessage:
          type: string
          nullable: true
          description: The agency's message with the submission.
        description:
          type: string
          nullable: true
      required:
        - id
        - title
        - status
        - productId
        - agencyAccountId
        - submissionReference
        - businessType
        - requestedEffectiveDate
        - requestedExpirationDate
        - receivedAt
        - agencyMessage
        - description
    V2UwGuidelinesVersion:
      type: object
      nullable: true
      properties:
        id:
          type: string
          description: The guidelines `id`.
        versionId:
          type: string
          description: The exact version. Read it with `downloadFile` and `versionId`.
        version:
          type: integer
          description: Version number, starting at 1.
      required:
        - id
        - versionId
        - version
      description: >-
        The guidelines version the submission's file is pinned to, or null
        before the file is opened.
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.