Audit Generated Form Smart Tags

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/generated/{id}/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/generated/{id}/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/generated/{id}/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/generated/{id}/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/generated/{id}/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

{
  "id": "550e8400-e29b-41d4-a716-446655440077",
  "fileKind": "docx",
  "findings": [
    {
      "identity": "AIIFmv1FldD0C243CFE936981C",
      "form": "anchor",
      "classification": "dead-hashed"
    }
  ],
  "summary": {
    "resolvable": 0,
    "framework": 0,
    "legacyRenameable": 0,
    "legacyOrphan": 0,
    "deadHashed": 1,
    "foreign": 0
  }
}

Generated Forms

Audit Generated Form Smart Tags

Read-only smart-tag audit of a generated form’s editable draft: 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. A form’s finalized (bound) copy is a rendered PDF with no anchors and is not audited; the draft is what stays bindable.

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 form reports only resolvable and framework findings.

Required permission: forms:read

GET

api

companies

{companyId}

forms

generated

{id}

smart-tag-audit

Audit Generated Form Smart Tags

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

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/generated/{id}/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/generated/{id}/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/generated/{id}/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/generated/{id}/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/generated/{id}/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

{
  "id": "550e8400-e29b-41d4-a716-446655440077",
  "fileKind": "docx",
  "findings": [
    {
      "identity": "AIIFmv1FldD0C243CFE936981C",
      "form": "anchor",
      "classification": "dead-hashed"
    }
  ],
  "summary": {
    "resolvable": 0,
    "framework": 0,
    "legacyRenameable": 0,
    "legacyOrphan": 0,
    "deadHashed": 1,
    "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

string<uuid>

required

The generated form's id (as returned by the List Generated Forms endpoint). Identifies one generated form instance — not a template; templates are addressed by their FM-XXXX number instead.

Response

The audit outcome for the form's draft.

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

string<uuid>

required

The audited generated form's id.

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 Generated Form Smart Tags

Authorizations

Path Parameters

Response