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

# Finalize Upload

> Phase 3 of the two-phase upload: after PUTting the bytes to the signed
`uploadUrl`, finalize with the `versionId` returned by the upload
intent. The server verifies the object exists in storage and flips the
file's status from `pending` to `ready`, making it visible to listings
and downloadable.

Finalizing a version that was already finalized is a `409`; finalizing
before the bytes were uploaded is a `400`.

**Required permission:** `company.file:create`




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/files/{fileId}/finalize
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/files/{fileId}/finalize:
    post:
      tags:
        - Company Files
      summary: Finalize Upload
      description: |
        Phase 3 of the two-phase upload: after PUTting the bytes to the signed
        `uploadUrl`, finalize with the `versionId` returned by the upload
        intent. The server verifies the object exists in storage and flips the
        file's status from `pending` to `ready`, making it visible to listings
        and downloadable.

        Finalizing a version that was already finalized is a `409`; finalizing
        before the bytes were uploaded is a `400`.

        **Required permission:** `company.file:create`
      operationId: finalizeCompanyFileUpload
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/fileId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - versionId
              properties:
                versionId:
                  type: string
                  format: uuid
                  description: The version id returned by the upload intent
            examples:
              finalize:
                summary: Finalize the uploaded version
                value:
                  versionId: 550e8400-e29b-41d4-a716-446655440021
      responses:
        '200':
          description: Upload finalized — the file is now `ready`
          content:
            application/json:
              schema:
                type: object
                properties:
                  fileId:
                    type: string
                    format: uuid
                    description: Id of the finalized file
                  versionId:
                    type: string
                    format: uuid
                    description: Id of the now-`ready` version
              examples:
                success:
                  summary: Upload finalized
                  value:
                    fileId: 550e8400-e29b-41d4-a716-446655440020
                    versionId: 550e8400-e29b-41d4-a716-446655440021
        '400':
          description: Bad Request — no object found in storage for this version
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                bytesNotUploaded:
                  summary: PUT to the signed URL never happened
                  value:
                    error:
                      code: BadRequest
                      message: No uploaded object found in storage for this version
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: File or version not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                versionNotFound:
                  summary: Unknown version
                  value:
                    error:
                      code: NotFound
                      message: 'Version not found: 550e8400-e29b-41d4-a716-446655440021'
        '409':
          description: Conflict — the version was already finalized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                alreadyFinalized:
                  summary: Repeat finalize
                  value:
                    error:
                      code: Conflict
                      message: >-
                        Version 550e8400-e29b-41d4-a716-446655440021 is already
                        finalized
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    fileId:
      name: fileId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: File identifier
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````