Audit Form Template Smart Tags

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit', 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/{number}/smart-tag-audit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "number": "FM-0012",
  "fileKind": "docx",
  "findings": [
    {
      "identity": "AIIFmv1Fld9E5D74B94AC85D40",
      "form": "anchor",
      "classification": "resolvable"
    }
  ],
  "summary": {
    "resolvable": 1,
    "framework": 0,
    "legacyRenameable": 0,
    "legacyOrphan": 0,
    "deadHashed": 0,
    "foreign": 0
  }
}

Templates

Audit Form Template Smart Tags

Read-only smart-tag audit of a form template’s current version: classifies every AII… smart-tag identity in the stored document — live anchors and dormant DOCVARIABLE authoring codes alike — against the company’s current field configuration. Nothing is written.

Use it to find document rot the write-path convergence cannot see: dead-hashed identities (render as raw hex and cannot self-heal), legacy-orphan names (readable but permanently unfilled), and foreign tags the platform cannot bind. A healthy template reports only resolvable and framework findings.

Required permission: forms:read

GET

api

companies

{companyId}

forms

template

{number}

smart-tag-audit

Audit Form Template Smart Tags

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit \
  --header 'Authorization: <api-key>'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit', 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/{number}/smart-tag-audit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/template/{number}/smart-tag-audit"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "number": "FM-0012",
  "fileKind": "docx",
  "findings": [
    {
      "identity": "AIIFmv1Fld9E5D74B94AC85D40",
      "form": "anchor",
      "classification": "resolvable"
    }
  ],
  "summary": {
    "resolvable": 1,
    "framework": 0,
    "legacyRenameable": 0,
    "legacyOrphan": 0,
    "deadHashed": 0,
    "foreign": 0
  }
}

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

number

string

required

The template's stable form number, e.g. FM-0012.

Response

The audit outcome for the template's current version.

A read-only classification of every AII… smart-tag identity a stored document carries, judged against the company's current field configuration.

number

string

required

The audited template's form number.

fileKind

enum<string>

required

static means a PDF file — it carries no smart-tag anchors, so the audit is an empty no-op.

Available options:

docx,

static

findings

object[]

required

One entry per (identity, form) the document carries, deduplicated and sorted by identity.

Show child attributes

summary

object

required

Finding counts per classification.

Show child attributes

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Audit Form Template Smart Tags

Authorizations

Path Parameters

Response