Touch Generated Form

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

import requests

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

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

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

print(response.text)

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

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/generated/{id}/touch', 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}/touch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/touch"

	req, _ := http.NewRequest("POST", 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}/touch")

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

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

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

{
  "id": "550e8400-e29b-41d4-a716-446655440077",
  "changed": true,
  "renamedTags": [
    "AIIFmv1NamedInsured"
  ],
  "metadataRefreshed": true
}

Generated Forms

Touch Generated Form

Brings a generated form up to date in place: converges any legacy-style smart-tag anchors in its editable draft to the current hashed identity format, and refreshes the form’s cached smart-tag metadata from the converged document. The request has no body.

Idempotent. A form that is already up to date reports changed: false and nothing is written — so re-running a touch (or a whole migration sweep) is safe, and a fleet-wide pass that reports changed: false everywhere proves every anchor RESOLVABLE against the company’s current field configuration is converged. Anchors naming a field the configuration does not define are deliberately left unrenamed (readable, repairable) and do not count as changes.

The form’s content is never altered: only the internal identity of each smart-tag anchor changes; displayed text, substituted values, and tag display names are preserved. A form with a finalized (bound) copy keeps that copy byte-for-byte untouched — only the editable draft converges. Static (PDF) forms have no smart-tag anchors and always report a clean no-op.

Required permission: forms:update

POST

api

companies

{companyId}

forms

generated

{id}

touch

Touch Generated Form

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

import requests

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

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

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

print(response.text)

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

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/forms/generated/{id}/touch', 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}/touch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/touch"

	req, _ := http.NewRequest("POST", 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}/touch")

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

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

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

{
  "id": "550e8400-e29b-41d4-a716-446655440077",
  "changed": true,
  "renamedTags": [
    "AIIFmv1NamedInsured"
  ],
  "metadataRefreshed": true
}

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 touch outcome. changed is true when anything was written — anchors renamed in the draft and/or metadata refreshed.

string<uuid>

required

The touched generated form's id.

changed

boolean

required

True when the touch wrote anything (anchors renamed and/or metadata refreshed); false when the form was already up to date.

renamedTags

string[]

required

The legacy smart-tag identities that were converged to the hashed format, one entry per unique identity. Empty when the draft was already converged.

metadataRefreshed

boolean

required

True when the form's cached smart-tag metadata was brought up to date. Always false for forms with a finalized (bound) copy, whose metadata is frozen.

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Touch Generated Form

Authorizations

Path Parameters

Response