> ## 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. # Get File Metadata > Returns full metadata for a single file, including its upload `status` (`pending` until the upload is finalized, then `ready`). Does not return file content — use [Get Download URL](#tag/Company-Files/GET/api/v1/companies/{companyId}/files/{fileId}/download-url) and fetch the bytes from the signed URL. A file placed on several entities is summarized by its PRIMARY (oldest) placement; `placementCount` > 1 flags the rest — enumerate them with [List File Placements](#tag/Company-Files/GET/api/v1/companies/{companyId}/files/{fileId}/placements). **Required permission:** `company.file:read` ## OpenAPI ````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/files/{fileId} 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}: get: tags: - Company Files summary: Get File Metadata description: > Returns full metadata for a single file, including its upload `status` (`pending` until the upload is finalized, then `ready`). Does not return file content — use [Get Download URL](#tag/Company-Files/GET/api/v1/companies/{companyId}/files/{fileId}/download-url) and fetch the bytes from the signed URL. A file placed on several entities is summarized by its PRIMARY (oldest) placement; `placementCount` > 1 flags the rest — enumerate them with [List File Placements](#tag/Company-Files/GET/api/v1/companies/{companyId}/files/{fileId}/placements). **Required permission:** `company.file:read` operationId: getCompanyFile parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/fileId' responses: '200': description: File metadata content: application/json: schema: $ref: '#/components/schemas/CompanyFile' examples: readyFile: summary: Finalized file value: id: 550e8400-e29b-41d4-a716-446655440020 entityType: company entityId: null displayName: master-agreement.pdf fileName: master-agreement.pdf contentType: application/pdf byteSize: 482133 status: ready folderId: null category: null placementCount: 1 createdAt: '2026-06-10T09:14:30.000Z' createdBy: 550e8400-e29b-41d4-a716-446655440099 updatedAt: '2026-06-10T09:15:00.000Z' uploadedAt: '2026-06-10T09:14:30.000Z' uploadedBy: 550e8400-e29b-41d4-a716-446655440099 pendingFile: summary: Upload intent not yet finalized value: id: 550e8400-e29b-41d4-a716-446655440020 entityType: company entityId: null displayName: master-agreement.pdf fileName: null contentType: null byteSize: null status: pending folderId: null category: null placementCount: 1 createdAt: '2026-06-10T09:14:30.000Z' createdBy: 550e8400-e29b-41d4-a716-446655440099 updatedAt: '2026-06-10T09:14:30.000Z' uploadedAt: null uploadedBy: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: File not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notFound: summary: File does not exist value: error: code: NotFound message: 'File not found: 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: CompanyFile: type: object description: > Full metadata for one file. Unlike the list shape this also represents files whose upload was never finalized: `status` is `pending` until finalize flips it to `ready`, and the version-derived fields (`fileName`, `contentType`, `byteSize`, `uploadedAt`, `uploadedBy`) are `null` while no current version exists. A file can be placed on more than one entity (see the placements endpoints). The owner fields here (`entityType`, `entityId`, `folderId`, `category`) reflect the file's PRIMARY placement — the oldest live one; `placementCount` > 1 flags that others exist. properties: id: type: string format: uuid description: File identifier entityType: type: string enum: - event - exposure - quote - submission - person - organization - policy - company description: The file owner's entity type entityId: type: string format: uuid nullable: true description: The owner entity's id (null for company-level files) displayName: type: string description: The file's display name (renameable) fileName: type: string nullable: true description: The immutable original filename of the current version contentType: type: string nullable: true description: MIME type of the current version byteSize: type: integer nullable: true description: Size of the current version in bytes status: type: string enum: - pending - ready - quarantined - infected description: | Upload lifecycle state. `pending` = upload intent created but not finalized; `ready` = bytes verified in storage and available for download; `quarantined` = malware scan verdict outstanding (not yet downloadable); `infected` = malware detected (downloads permanently refused). folderId: type: string format: uuid nullable: true description: The folder the file is placed in (null = the owner's top level) category: type: string nullable: true description: Optional category label (per placement; the primary placement's) placementCount: type: integer description: > Number of live placements across all owners. Greater than 1 means the file is shared — enumerate them via List File Placements. createdAt: type: string format: date-time description: When the file record was created (ISO 8601) createdBy: type: string nullable: true description: Id of the creating user / API key creator updatedAt: type: string format: date-time description: When the file record was last updated (ISO 8601) displayDate: type: string format: date-time nullable: true description: >- Optional back-datable "as of" date. When set, listings display and sort the file by this date instead of `uploadedAt` — intended for historical imports and integrations. displayAuthor: type: string nullable: true description: >- Optional user-visible uploader label. When set, the file is presented as uploaded by this label instead of the uploader's name — intended for historical imports carrying the source system's author (or a marker like "Data Import"). Uploader attribution stays server-set. uploadedAt: type: string format: date-time nullable: true description: When the current version was uploaded (ISO 8601) uploadedBy: type: string nullable: true description: Id of the user / API key creator who uploaded the current version 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 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. ````