> ## 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.

# Upload a filing document

> Prepare one document for this filing and return a signed PUT URL. Upload the bytes with the returned headers, then confirm the upload. Requires filing edit access. Each request starts a new upload; keep the returned token for completion.



## OpenAPI

````yaml /openapi.json post /insurance/managed-filings/{filingId}/uploads
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://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/managed-filings/{filingId}/uploads:
    post:
      tags:
        - Managed Filings
      summary: Upload a filing document
      description: >-
        Prepare one document for this filing and return a signed PUT URL. Upload
        the bytes with the returned headers, then confirm the upload. Requires
        filing edit access. Each request starts a new upload; keep the returned
        token for completion.
      operationId: createManagedFilingUpload
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ManagedFilingUploadCreate'
      responses:
        '200':
          description: Instructions for uploading the file. Valid for one hour.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ManagedFilingUpload'
        '400':
          description: >-
            Invalid file details, invalid/expired completion token, or
            invalid_upload_content: correct the file and start a new upload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Filing edit permission required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Filing not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            Filing is read-only, uploaded bytes are not ready, or another
            completion changed the file. Retry a concurrent completion after the
            other request finishes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Request exceeds 32 KiB.
          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. Retry-After is in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ManagedFilingUploadCreate:
      type: object
      properties:
        fileName:
          type: string
          minLength: 1
          maxLength: 255
          description: >-
            Filename including extension, for example form.pdf. Maximum 255
            characters.
        sizeBytes:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: Exact file size in bytes.
        mimeType:
          type: string
          minLength: 1
          maxLength: 255
          description: >-
            Media type, for example application/pdf. Inferred from the filename
            when omitted.
      required:
        - fileName
        - sizeBytes
      additionalProperties: false
    V2ManagedFilingUpload:
      type: object
      properties:
        uploadToken:
          type: string
          minLength: 1
          maxLength: 16384
          description: >-
            Opaque upload token. Return it unchanged to the completion endpoint
            for this filing within one hour.
        fileName:
          type: string
          description: Selected filename; may be renamed to avoid a collision.
        uploadUrl:
          type: string
          format: uri
          description: Pre-signed URL for direct PUT upload to storage
        method:
          type: string
          enum:
            - PUT
        headers:
          type: object
          additionalProperties:
            type: string
          description: >-
            Include these headers when uploading the bytes. Send API credentials
            only to Effective, not to the upload URL.
        expiresAt:
          type: string
          format: date-time
          description: Expiry of the upload URL and completion token.
      required:
        - uploadToken
        - fileName
        - uploadUrl
        - method
        - headers
        - expiresAt
      additionalProperties: false
    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.
          required:
            - code
    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.