Upload Form Template

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "loss-notice.docx",
  "fileBase64": "UEsDBBQABgAIAAAAIQ...",
  "category": "event"
}
'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template"

payload = {
    "fileName": "loss-notice.docx",
    "fileBase64": "UEsDBBQABgAIAAAAIQ...",
    "category": "event"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileName: 'loss-notice.docx',
    fileBase64: 'UEsDBBQABgAIAAAAIQ...',
    category: 'event'
  })
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fileName' => 'loss-notice.docx',
    'fileBase64' => 'UEsDBBQABgAIAAAAIQ...',
    'category' => 'event'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template"

	payload := strings.NewReader("{\n  \"fileName\": \"loss-notice.docx\",\n  \"fileBase64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"category\": \"event\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileName\": \"loss-notice.docx\",\n  \"fileBase64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"category\": \"event\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fileName\": \"loss-notice.docx\",\n  \"fileBase64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"category\": \"event\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

Templates

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<ReferenceId> 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

POST

api

companies

{companyId}

forms

template

Upload Form Template

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileName": "loss-notice.docx",
  "fileBase64": "UEsDBBQABgAIAAAAIQ...",
  "category": "event"
}
'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template"

payload = {
    "fileName": "loss-notice.docx",
    "fileBase64": "UEsDBBQABgAIAAAAIQ...",
    "category": "event"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileName: 'loss-notice.docx',
    fileBase64: 'UEsDBBQABgAIAAAAIQ...',
    category: 'event'
  })
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'fileName' => 'loss-notice.docx',
    'fileBase64' => 'UEsDBBQABgAIAAAAIQ...',
    'category' => 'event'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template"

	payload := strings.NewReader("{\n  \"fileName\": \"loss-notice.docx\",\n  \"fileBase64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"category\": \"event\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileName\": \"loss-notice.docx\",\n  \"fileBase64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"category\": \"event\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fileName\": \"loss-notice.docx\",\n  \"fileBase64\": \"UEsDBBQABgAIAAAAIQ...\",\n  \"category\": \"event\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

Authorizations

Authorization

string

header

required

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.

Path Parameters

companyId

string<uuid>

required

Company identifier

Body

application/json

fileName

string

required

Original file name, including the .docx extension. Used as the template's display name. Must be non-empty.

fileBase64

string

required

The raw .docx bytes, base64-encoded.

Response

Form template created

A single form-template checkpoint.

templateKey

string<uuid>

required

Stable identifier of the template across its versions.

checkpointId

string<uuid>

required

Identifier of this specific checkpoint (version) of the template.

companyId

string<uuid>

required

name

string

required

Display name (derived from the uploaded file name).

number

string

required

Human-facing form number (e.g. FM-0010).

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Upload Form Template

Authorizations

Path Parameters

Body

Response