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

# Recover a document uploaded by a SERFF import

> Read one saved upload completion by its exact completion key, including a document not yet linked to a filing item. Requires ownership of the import and current access to the filing and document. Read-only and safe to repeat.

Completed returns the original completion metadata; inspect current file metadata before linking it. Not_found means no completion was recorded under this key, not proof that upload preparation or another write never happened. Uncertain means the write has no confirmed outcome: stop writes and reconcile it. Rejected means the saved completion returned an error. This read does not clear receipts, retry writes or return upload credentials.



## OpenAPI

````yaml /openapi.json get /insurance/serff-import-items/{id}/uploaded-document
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/serff-import-items/{id}/uploaded-document:
    get:
      tags:
        - SERFF Imports
      summary: Recover a document uploaded by a SERFF import
      description: >-
        Read one saved upload completion by its exact completion key, including
        a document not yet linked to a filing item. Requires ownership of the
        import and current access to the filing and document. Read-only and safe
        to repeat.


        Completed returns the original completion metadata; inspect current file
        metadata before linking it. Not_found means no completion was recorded
        under this key, not proof that upload preparation or another write never
        happened. Uncertain means the write has no confirmed outcome: stop
        writes and reconcile it. Rejected means the saved completion returned an
        error. This read does not clear receipts, retry writes or return upload
        credentials.
      operationId: getSerffImportUploadedDocument
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9_.:-]+$
            description: >-
              Exact Idempotency-Key used for the upload completion, not its
              preparation.
          required: true
          description: >-
            Exact Idempotency-Key used for the upload completion, not its
            preparation.
          name: completionKey
          in: query
      responses:
        '200':
          description: >-
            Saved completion state and, when available, its currently accessible
            document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2SerffImportUploadedDocument'
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            Opening the session and registering need your signed-in user
            credential; other operations also accept your own agent. Login must
            be your personal account or an organization-shared account for the
            destination.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Item or a selected reference is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            Session initialization is in progress, source selections conflict,
            or the item revision changed. Read current state before retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Request exceeds 128 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. A session may have been reserved; retry the
            same request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: >-
            Selections are saved but dispatch is unavailable. Repeat the same
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2SerffImportUploadedDocument:
      oneOf:
        - type: object
          properties:
            status:
              type: string
              enum:
                - completed
            document:
              $ref: '#/components/schemas/V2ManagedFilingUploadedFile'
          required:
            - status
            - document
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              enum:
                - not_found
                - uncertain
                - rejected
            document:
              nullable: true
          required:
            - status
            - document
          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.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: Not currently returned.
          required:
            - code
    V2ManagedFilingUploadedFile:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: File ID. Use as artifactId when adding a filing item or attachment.
        name:
          type: string
          description: Saved filename, including any suffix added to avoid a collision.
        sizeBytes:
          type: integer
          minimum: 0
        mimeType:
          type: string
      required:
        - id
        - name
        - sizeBytes
        - mimeType
      additionalProperties: false
    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.