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

# Add File Placement (Share to Another Entity)

> Adds a placement of an existing file under another owner — the file then
appears on both entities. Sharing never copies the stored bytes: every
placement sees the same current version and version history. The target
owner is validated like an upload intent's (a live entity in the same
company — cross-company sharing is not possible); an optional `folderId`
files the new placement inside one of the TARGET owner's folders.

Folder location and `category` are independent per placement (the new
placement starts at the target's top level with no category);
`displayName` stays on the file — one name everywhere.

Adding a placement on an owner the file is already placed on returns
`409 Conflict`.

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




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/files/{fileId}/placements
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}/placements:
    post:
      tags:
        - Company Files
      summary: Add File Placement (Share to Another Entity)
      description: |
        Adds a placement of an existing file under another owner — the file then
        appears on both entities. Sharing never copies the stored bytes: every
        placement sees the same current version and version history. The target
        owner is validated like an upload intent's (a live entity in the same
        company — cross-company sharing is not possible); an optional `folderId`
        files the new placement inside one of the TARGET owner's folders.

        Folder location and `category` are independent per placement (the new
        placement starts at the target's top level with no category);
        `displayName` stays on the file — one name everywhere.

        Adding a placement on an owner the file is already placed on returns
        `409 Conflict`.

        **Required permission:** `company.file:create`
      operationId: addCompanyFilePlacement
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/fileId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - entityType
              properties:
                entityType:
                  type: string
                  enum:
                    - event
                    - exposure
                    - quote
                    - submission
                    - person
                    - organization
                    - policy
                    - company
                  description: The target owner's entity type
                entityId:
                  type: string
                  format: uuid
                  nullable: true
                  description: >-
                    The target entity's id; null (or omitted) only for
                    `entityType: company`
                folderId:
                  type: string
                  format: uuid
                  nullable: true
                  description: >-
                    Optional folder of the TARGET owner to place the file in
                    (null/omitted = the target's top level)
            examples:
              shareToSubmission:
                summary: Share an Event's file to a Submission
                value:
                  entityType: submission
                  entityId: 550e8400-e29b-41d4-a716-446655440011
              shareToCompanyFiles:
                summary: Share to the company-level Files
                value:
                  entityType: company
                  entityId: null
      responses:
        '201':
          description: Placement added
          content:
            application/json:
              schema:
                type: object
                properties:
                  placementId:
                    type: string
                    format: uuid
                    description: The new placement's id
                  fileId:
                    type: string
                    format: uuid
                    description: The shared file's id (unchanged)
                  entityType:
                    type: string
                    description: The target owner's entity type
                  entityId:
                    type: string
                    format: uuid
                    nullable: true
                    description: The target entity's id
                  folderId:
                    type: string
                    format: uuid
                    nullable: true
                    description: The folder the new placement sits in
              examples:
                success:
                  summary: Placement added
                  value:
                    placementId: 550e8400-e29b-41d4-a716-446655440032
                    fileId: 550e8400-e29b-41d4-a716-446655440020
                    entityType: submission
                    entityId: 550e8400-e29b-41d4-a716-446655440011
                    folderId: null
        '400':
          description: Bad Request — Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                wrongOwnerFolder:
                  summary: Target folder belongs to a different owner
                  value:
                    error:
                      code: BadRequest
                      message: Folder does not belong to the file owner
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: File or target entity not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ownerNotFound:
                  summary: Target entity does not exist in this company
                  value:
                    error:
                      code: NotFound
                      message: >-
                        Owner entity not found:
                        550e8400-e29b-41d4-a716-446655440011
        '409':
          description: The file is already placed on the target owner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                duplicate:
                  summary: Duplicate placement
                  value:
                    error:
                      code: Conflict
                      message: >-
                        File is already placed on this owner:
                        550e8400-e29b-41d4-a716-446655440020
        '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.

````