Compare Configuration

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/compare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [],
  "pages": [],
  "cards": [],
  "cardPageRelationships": [],
  "optionSets": [],
  "customObjects": [],
  "fieldLocations": [],
  "ratingWorkflows": [],
  "entityInvariants": []
}
'

import requests

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

payload = {
    "fields": [],
    "pages": [],
    "cards": [],
    "cardPageRelationships": [],
    "optionSets": [],
    "customObjects": [],
    "fieldLocations": [],
    "ratingWorkflows": [],
    "entityInvariants": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fields: [],
    pages: [],
    cards: [],
    cardPageRelationships: [],
    optionSets: [],
    customObjects: [],
    fieldLocations: [],
    ratingWorkflows: [],
    entityInvariants: []
  })
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/compare', 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}/configuration/compare",
  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([
    'fields' => [
        
    ],
    'pages' => [
        
    ],
    'cards' => [
        
    ],
    'cardPageRelationships' => [
        
    ],
    'optionSets' => [
        
    ],
    'customObjects' => [
        
    ],
    'fieldLocations' => [
        
    ],
    'ratingWorkflows' => [
        
    ],
    'entityInvariants' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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}/configuration/compare"

	payload := strings.NewReader("{\n  \"fields\": [],\n  \"pages\": [],\n  \"cards\": [],\n  \"cardPageRelationships\": [],\n  \"optionSets\": [],\n  \"customObjects\": [],\n  \"fieldLocations\": [],\n  \"ratingWorkflows\": [],\n  \"entityInvariants\": []\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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}/configuration/compare")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": [],\n  \"pages\": [],\n  \"cards\": [],\n  \"cardPageRelationships\": [],\n  \"optionSets\": [],\n  \"customObjects\": [],\n  \"fieldLocations\": [],\n  \"ratingWorkflows\": [],\n  \"entityInvariants\": []\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": [],\n  \"pages\": [],\n  \"cards\": [],\n  \"cardPageRelationships\": [],\n  \"optionSets\": [],\n  \"customObjects\": [],\n  \"fieldLocations\": [],\n  \"ratingWorkflows\": [],\n  \"entityInvariants\": []\n}"

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

{
  "fieldDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 42
  },
  "optionSets": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 8
  },
  "customObjects": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 3
  },
  "cardDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 12
  },
  "cardPageRelationships": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 6
  },
  "fieldLocations": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 38
  }
}

Validate & Compare

Compare Configuration

Shows what applying a full configuration document would add, change, or remove (fields, dropdown option sets, custom objects, and the rest), without changing anything. Use it after editing the output of Export Configuration (exportFmv1Configuration), or before restoring a configuration backup, to preview what Import Configuration (importFmv1Configuration) would do. For a verdict that also runs import’s breaking-change check, call Import Configuration with ?dryRun=true instead.

Compares an FMV1 configuration supplied as a structured JSON body against the current database state and returns a diff summary. The body is the structured FMV1 configuration shape (the same one export returns). Each configuration category (field definitions, option sets, custom objects, etc.) includes counts of additions, updates, deletes, and unchanged items.

Use it to preview what an import would change before applying it. It is read-only — it computes a diff and writes nothing.

Required permission: configuration.view

This endpoint requires an API key that holds the configuration permissions — the Admin role does. See Authentication for how to create API keys with specific roles.

POST

api

companies

{companyId}

configuration

compare

Compare Configuration

curl --request POST \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/compare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": [],
  "pages": [],
  "cards": [],
  "cardPageRelationships": [],
  "optionSets": [],
  "customObjects": [],
  "fieldLocations": [],
  "ratingWorkflows": [],
  "entityInvariants": []
}
'

import requests

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

payload = {
    "fields": [],
    "pages": [],
    "cards": [],
    "cardPageRelationships": [],
    "optionSets": [],
    "customObjects": [],
    "fieldLocations": [],
    "ratingWorkflows": [],
    "entityInvariants": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fields: [],
    pages: [],
    cards: [],
    cardPageRelationships: [],
    optionSets: [],
    customObjects: [],
    fieldLocations: [],
    ratingWorkflows: [],
    entityInvariants: []
  })
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/compare', 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}/configuration/compare",
  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([
    'fields' => [
        
    ],
    'pages' => [
        
    ],
    'cards' => [
        
    ],
    'cardPageRelationships' => [
        
    ],
    'optionSets' => [
        
    ],
    'customObjects' => [
        
    ],
    'fieldLocations' => [
        
    ],
    'ratingWorkflows' => [
        
    ],
    'entityInvariants' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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}/configuration/compare"

	payload := strings.NewReader("{\n  \"fields\": [],\n  \"pages\": [],\n  \"cards\": [],\n  \"cardPageRelationships\": [],\n  \"optionSets\": [],\n  \"customObjects\": [],\n  \"fieldLocations\": [],\n  \"ratingWorkflows\": [],\n  \"entityInvariants\": []\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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}/configuration/compare")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": [],\n  \"pages\": [],\n  \"cards\": [],\n  \"cardPageRelationships\": [],\n  \"optionSets\": [],\n  \"customObjects\": [],\n  \"fieldLocations\": [],\n  \"ratingWorkflows\": [],\n  \"entityInvariants\": []\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": [],\n  \"pages\": [],\n  \"cards\": [],\n  \"cardPageRelationships\": [],\n  \"optionSets\": [],\n  \"customObjects\": [],\n  \"fieldLocations\": [],\n  \"ratingWorkflows\": [],\n  \"entityInvariants\": []\n}"

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

{
  "fieldDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 42
  },
  "optionSets": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 8
  },
  "customObjects": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 3
  },
  "cardDefinitions": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 12
  },
  "cardPageRelationships": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 6
  },
  "fieldLocations": {
    "additions": 0,
    "updates": 0,
    "deletes": 0,
    "unchanged": 38
  }
}

Authorizations

Authorization

string

header

required

User-principal OAuth 2.0 Bearer authentication. Send a user-scoped Auth0 access token (audience = the app API audience) as Authorization: Bearer <jwt>. The request resolves to the user's identity and is authorized by their Role on the {companyId} in the path — the same role-based permissions the web app enforces. This is the path the MCP connector uses to act on a user's behalf; endpoints that accept it list both BearerAuth and ApiKeyAuth.

Path Parameters

companyId

string<uuid>

required

Company identifier

Body

application/json

Option 1
Option 2

A COMPLETE configuration body (the same one export returns). A delta/patch body is rejected with a 400 — typed changes go to the patch endpoint (POST .../configuration/patch).

fields

object[]

required

Field definitions, keyed by entity + reference id.

One top-level field definition, keyed by entity + reference id. Declare its type with structured typeInfo. Legacy type and string-encoded typeArgs remain accepted; when both representations are supplied they must agree semantically. A conflict is rejected with the field identity. Exports use typeInfo without the legacy duplicate properties.

Option 1
Option 2

Show child attributes

pages

object[]

required

Page definitions.

Show child attributes

cards

object[]

required

Card definitions.

Show child attributes

cardPageRelationships

object[]

required

Placements of cards onto pages.

Show child attributes

optionSetTypes

object[]

required

Option-set type declarations.

Show child attributes

objectTypes

object[]

required

Custom-object type declarations.

Show child attributes

optionSets

object[]

required

Option sets and their options.

Show child attributes

objects

object[]

required

Custom-object sub-field definitions, joined to object types.

Show child attributes

fieldLocations

object[]

required

Field placements (the layout) onto cards.

Show child attributes

ratingWorkflows

object[]

required

Rating workflow definitions.

Show child attributes

entityInvariants

object[]

required

Per-entity invariant conditions enforced on every write.

Show child attributes

formLogicRules

object[]

Forms-logic rules (quote-flow auto-add rules). Optional — existing payloads predate the "Forms" tab; absent ⇒ no rules.

Show child attributes

smartTags

object[]

Smart tags — the named values resolved into generated documents. Optional: existing payloads predate the slice, and absent ⇒ no smart tags, which is also how a company that has not yet moved to this format is recognised.

Omitted from an export when the company has none, rather than emitted as an empty array.

Show child attributes

exportSurfaces

object[]

Declared export columns — the tenant-facing column set of each export surface (the seven entity exports plus the bordereau). Optional: existing payloads predate the slice, and absent ⇒ no declared columns, which is also how a surface that still offers every configured field is recognised.

Activation is per surface: a surface with at least one row here resolves its whole tenant column set through those rows, in the order they appear; a surface with none behaves exactly as it did before this section existed.

Omitted from an export when the company has declared none, rather than emitted as an empty array.

Show child attributes

listColumns

object[]

Declared list columns — the complete tenant-facing column set of each entity list page. Optional: existing payloads predate the slice, and absent ⇒ no declared tenant columns, so each list renders only its platform/system columns.

Rows declare membership, not order or default visibility. The platform's per-page defaults and each user's saved view own those choices; the stored configuration sorts rows canonically by (surface, key).

Omitted from an export when the company has declared none, rather than emitted as an empty array.

Show child attributes

listFilters

object[]

Tenant-defined list filters, one per (surface, key). Together with page-owned system filters, these rows are the complete user-visible filter catalog. listColumns contributes no filters.

Optional for wire compatibility with payloads that predate the slice. Absent or empty means that each entity list offers only its page-owned system filters. Omitted from an export when the company has none.

Show child attributes

billingConditions

object[]

Optional named Quote billing conditions. Each condition key has one * default and optional per-flow overrides. False conditions skip the billing calculation and leave its value null without refusing saving or binding. Rows are sorted by (conditionKey, quoteFlow). Omitted from an export when absent or empty, preserving existing configuration exports.

Show child attributes

conversionRules

object[]

Exceptions to the default copy between Policy and Quote. At bind and at draft generation, every shared field (declared on Quote and Policy with the same referenceId and value type, and neither calculated on the destination nor system-managed or platform-owned) is copied unchanged unless a rule in that direction and transaction type names it. A rule names a field when its destinationPath is the field or a path under it. An expression of exactly SKIP() writes nothing; any other expression writes its result, including to a differently named destination. A field declared on one entity only is written only by a rule. The default copy is not stored as rules and is not exported.

Each rule is identified by its (direction, transactionType, destinationPath) triple; duplicates are rejected. The stored configuration sorts the section canonically by that triple. Import validates explicit rules and requires all framework-pinned rows, including on first import. Omitting or emptying the section is invalid, even with force enabled. Preserve the authored slice through whole-configuration imports. Field edits require reviewing affected rules against business intent: adding a shared field carries it with no rule, and deleting a rule on a shared field turns the default copy on for it.

Show child attributes

retirementIdentities

object[]

Server-derived memory for retired data addresses. Records have exactly one of three kinds: top-level field, custom-object subfield, or option-set value. A submitted copy is accepted for export/import round trips but is non-authoritative; the server derives the next set from the previous immutable configuration version. Omitted when empty.

Option 1
Option 2
Option 3

Show child attributes

exportPlatformColumns

object[]

Spreadsheet types for built-in (platform) export columns, one per (surface, column). Optional: absent or empty means platform columns keep their built-in formatting. column must name a built-in column of the surface (checked by name at import). Omitted from an export when empty.

Show child attributes

brokerPortal

object

Broker Portal customization. Optional, and omitted from an export when absent. This section does not turn the portal on: a platform admin enables the portal separately, and a configuration import cannot. The portal's logo and colours are the company's branding in Company Settings, not configuration.

Show child attributes

searchFields

object[]

The values the search index holds, per record type: list search and global search find a record by them. A record's display-name field is always searchable without a row. Optional: absent or empty means each record is searchable by its name only. Omitted from an export when empty.

Show child attributes

searchResultFields

object[]

The fields or calculated values a global search result shows, per record type, read from the record when the search runs. Optional: absent or empty means a result shows its name and the fields that matched. Omitted from an export when empty.

A field or calculated value shown in global search and authorized relationship pickers. Without an expression, key names a top-level field of any kind. With an expression, key is an independent identifier and valueType and cardinality are required. Copy these three properties from a list column on the same entity type. Expressions use the same bare field/JEXL grammar and pure/temporal functions as list columns. VIEW_AS_OF_DATE() is today's UTC date here. Database reads, entity-bound functions, mutations and attached form numbers are unavailable. Values are evaluated when search runs; they do not make records searchable and require no reindex.

Option 1
Option 2

Show child attributes

graphSettings

object

The company's graph settings: the time zone every graph reads today and day boundaries in. Required once any graph data point is declared. Omitted from an export when absent.

Show child attributes

graphDataPoints

object[]

Graph data points: how dashboard graphs read numbers out of records. Optional: absent or empty means none. Omitted from an export when empty.

Show child attributes

Response

Comparison completed

Diff between the supplied configuration and the current database configuration

fieldDefinitions

object

required