> ## 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. # Upload Form Template > Upload a form template (a `.docx`) into a company instance under a chosen category, validating its embedded smart tags before the template is committed. The forcing use case is migrating forms between instances: the uploaded DOCX already carries its smart-tag anchors, and this endpoint confirms each one still resolves to an available, smart-tag-enabled field on the destination instance for the chosen `category`. If any embedded tag is unknown, named with the retired legacy `AIIFmv1` style (the per-tag error names the current hashed replacement), not enabled as a smart tag, on the wrong category, or maps to an unsupported field type, the **entire upload is rejected** with a per-tag `400` — nothing is written — so a broken form never lands silently. **DOCX only.** Only DOCX carries the OOXML smart-tag anchors this endpoint validates; other formats are rejected. The file rides the request as base64 (the bytes must pass through the API so the tags can be validated before commit). **Category** is required and must be a smart-tag-scoped category: - `event` — Claim/Incident forms - `quote-flow` — Quote forms - `quote-bind-flow` — Policy forms **Required permission:** `forms:create` ## OpenAPI ````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/forms/template 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}/forms/template: post: tags: - Forms summary: Upload Form Template description: > Upload a form template (a `.docx`) into a company instance under a chosen category, validating its embedded smart tags before the template is committed. The forcing use case is migrating forms between instances: the uploaded DOCX already carries its smart-tag anchors, and this endpoint confirms each one still resolves to an available, smart-tag-enabled field on the destination instance for the chosen `category`. If any embedded tag is unknown, named with the retired legacy `AIIFmv1` style (the per-tag error names the current hashed replacement), not enabled as a smart tag, on the wrong category, or maps to an unsupported field type, the **entire upload is rejected** with a per-tag `400` — nothing is written — so a broken form never lands silently. **DOCX only.** Only DOCX carries the OOXML smart-tag anchors this endpoint validates; other formats are rejected. The file rides the request as base64 (the bytes must pass through the API so the tags can be validated before commit). **Category** is required and must be a smart-tag-scoped category: - `event` — Claim/Incident forms - `quote-flow` — Quote forms - `quote-bind-flow` — Policy forms **Required permission:** `forms:create` operationId: uploadFormTemplate parameters: - $ref: '#/components/parameters/companyId' requestBody: required: true content: application/json: schema: type: object required: - fileName - fileBase64 - category properties: fileName: type: string description: | Original file name, including the `.docx` extension. Used as the template's display name. Must be non-empty. fileBase64: type: string description: The raw `.docx` bytes, base64-encoded. category: type: string enum: - event - quote-flow - quote-bind-flow description: > The form category — selects which entity data source resolves the form's smart tags. examples: migratedClaimForm: summary: A migrated claim form with embedded smart tags value: fileName: loss-notice.docx fileBase64: UEsDBBQABgAIAAAAIQ... category: event responses: '201': description: Form template created content: application/json: schema: $ref: '#/components/schemas/Fmv1FormTemplateSummary' examples: success: summary: Created template value: templateKey: 550e8400-e29b-41d4-a716-446655440040 checkpointId: 550e8400-e29b-41d4-a716-446655440041 companyId: 550e8400-e29b-41d4-a716-446655440000 name: loss-notice number: FM-0010 category: event storagePath: >- acme/550e8400-.../formTemplates/550e8400-.../V-001/550e8400-....docx createdAt: '2026-06-29T09:15:00.000Z' createdBy: 550e8400-e29b-41d4-a716-446655440099 updatedAt: '2026-06-29T09:15:00.000Z' updatedBy: 550e8400-e29b-41d4-a716-446655440099 '400': description: | Bad Request — a non-DOCX upload, a missing/invalid field, or one or more invalid smart tags (including tags using the retired legacy `AIIFmv1` naming — the per-tag message names the hashed replacement). For invalid smart tags, `details` lists one entry per offending tag (`field` is `smartTags.`). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: notDocx: summary: Non-DOCX upload value: error: code: external-form-upload-docx-only message: >- Only .docx form templates can be uploaded through the API. Convert the file to .docx and try again. userMessages: - >- Only .docx form templates can be uploaded through the API. Convert the file to .docx and try again. invalidSmartTags: summary: Embedded smart tags that are not valid for the category value: error: code: invalid-smart-tags message: >- Uploaded form references smart tags that are not valid for the selected category. userMessages: - >- "AIIFmv1Missing" does not match any smart tag available for this form category. The referenced field may not exist in this instance, may not be enabled as a smart tag, or may belong to a different category. details: - field: smartTags.AIIFmv1Missing message: >- "AIIFmv1Missing" does not match any smart tag available for this form category. The referenced field may not exist in this instance, may not be enabled as a smart tag, or may belong to a different category. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' components: parameters: companyId: name: companyId in: path required: true schema: type: string format: uuid description: Company identifier schemas: Fmv1FormTemplateSummary: type: object description: A single form-template checkpoint. required: - templateKey - checkpointId - companyId - name - number - category - storagePath - createdAt - updatedAt properties: templateKey: type: string format: uuid description: Stable identifier of the template across its versions. checkpointId: type: string format: uuid description: Identifier of this specific checkpoint (version) of the template. companyId: type: string format: uuid name: type: string description: Display name (derived from the uploaded file name). number: type: string description: Human-facing form number (e.g. `FM-0010`). category: type: string enum: - event - quote-flow - quote-bind-flow - unknown description: The form category assigned to the template. storagePath: type: string description: Internal storage key of the checkpoint's document. createdAt: type: string format: date-time createdBy: type: string nullable: true updatedAt: type: string format: date-time updatedBy: type: string nullable: true 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. ````