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": [],
  "optionSetTypes": [],
  "objectTypes": [],
  "optionSets": [],
  "objects": [],
  "objectPrimitives": [],
  "fieldLocations": [],
  "ratingWorkflows": [],
  "entityInvariants": []
}
'

import requests

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

payload = {
    "fields": [],
    "pages": [],
    "cards": [],
    "cardPageRelationships": [],
    "optionSetTypes": [],
    "objectTypes": [],
    "optionSets": [],
    "objects": [],
    "objectPrimitives": [],
    "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: [],
    optionSetTypes: [],
    objectTypes: [],
    optionSets: [],
    objects: [],
    objectPrimitives: [],
    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' => [
        
    ],
    'optionSetTypes' => [
        
    ],
    'objectTypes' => [
        
    ],
    'optionSets' => [
        
    ],
    'objects' => [
        
    ],
    'objectPrimitives' => [
        
    ],
    '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  \"optionSetTypes\": [],\n  \"objectTypes\": [],\n  \"optionSets\": [],\n  \"objects\": [],\n  \"objectPrimitives\": [],\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  \"optionSetTypes\": [],\n  \"objectTypes\": [],\n  \"optionSets\": [],\n  \"objects\": [],\n  \"objectPrimitives\": [],\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  \"optionSetTypes\": [],\n  \"objectTypes\": [],\n  \"optionSets\": [],\n  \"objects\": [],\n  \"objectPrimitives\": [],\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

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: company.configuration:export

This endpoint requires an API key created with the FMV1_CONFIGURATION_MANAGER role. 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": [],
  "optionSetTypes": [],
  "objectTypes": [],
  "optionSets": [],
  "objects": [],
  "objectPrimitives": [],
  "fieldLocations": [],
  "ratingWorkflows": [],
  "entityInvariants": []
}
'

import requests

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

payload = {
    "fields": [],
    "pages": [],
    "cards": [],
    "cardPageRelationships": [],
    "optionSetTypes": [],
    "objectTypes": [],
    "optionSets": [],
    "objects": [],
    "objectPrimitives": [],
    "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: [],
    optionSetTypes: [],
    objectTypes: [],
    optionSets: [],
    objects: [],
    objectPrimitives: [],
    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' => [
        
    ],
    'optionSetTypes' => [
        
    ],
    'objectTypes' => [
        
    ],
    'optionSets' => [
        
    ],
    'objects' => [
        
    ],
    'objectPrimitives' => [
        
    ],
    '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  \"optionSetTypes\": [],\n  \"objectTypes\": [],\n  \"optionSets\": [],\n  \"objects\": [],\n  \"objectPrimitives\": [],\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  \"optionSetTypes\": [],\n  \"objectTypes\": [],\n  \"optionSets\": [],\n  \"objects\": [],\n  \"objectPrimitives\": [],\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  \"optionSetTypes\": [],\n  \"objectTypes\": [],\n  \"optionSets\": [],\n  \"objects\": [],\n  \"objectPrimitives\": [],\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

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.

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

objectPrimitives

object[]

required

Object-primitive sub-field definitions (Address / Date / Currency).

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

Response

Comparison completed

Diff between the supplied configuration and the current database configuration

fieldDefinitions

object

required