List Seed Options

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/seed/options \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/seed/options', 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/seed/options",
  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: Bearer <token>"
  ],
]);

$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}/configuration/seed/options"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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}/configuration/seed/options")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "defaultStarterSheet": "single-exposure-list",
  "options": [
    {
      "name": "default-rater",
      "description": "Alias of single-exposure-list: single exposure-list modeling with the default rater. Retained for backward compatibility.",
      "isDefault": false
    },
    {
      "name": "single-exposure-list",
      "description": "Single exposure-list modeling (one embedded exposures list per record with a calculated primary insured) paired with the default rater. This is the product default applied when starterSheet is omitted.",
      "isDefault": true
    },
    {
      "name": "standalone-primary-insured",
      "description": "Standalone primary-insured modeling: a written primary insured plus additional standalone exposures. A self-contained no-rating exposure scheme that keeps its own null default rater.",
      "isDefault": false
    }
  ],
  "modules": [
    {
      "id": "core",
      "label": "Core",
      "description": "Framework-required, non-configurable rows and the canonical sheet structure. Required on every configuration.",
      "defaultSelected": true,
      "group": "always-on",
      "alwaysOn": true
    },
    {
      "id": "default",
      "label": "Default",
      "description": "Shared configurable rows that are identical regardless of exposure scheme (fields, layout, option sets, entity invariants).",
      "defaultSelected": true,
      "group": "always-on",
      "alwaysOn": true
    },
    {
      "id": "default-rater",
      "label": "Default Rater",
      "description": "The default rating setup (rating axis). Composable with an exposure scheme; mutually exclusive with Example Rater and No-Rater Billing.",
      "defaultSelected": true,
      "group": "rating",
      "alwaysOn": false
    },
    {
      "id": "example-rater",
      "label": "Example Rater",
      "description": "The same default rating setup, shipping both example rating workflows side by side. Mutually exclusive with Default Rater and No-Rater Billing.",
      "defaultSelected": false,
      "group": "rating",
      "alwaysOn": false
    },
    {
      "id": "policy-number-manual",
      "label": "Policy Number — Manual",
      "description": "The policy number entered by the user as a required text box. Mutually exclusive with the auto policy-number flavor.",
      "defaultSelected": true,
      "group": "policy-number",
      "alwaysOn": false
    },
    {
      "id": "policy-number-auto",
      "label": "Policy Number — Auto",
      "description": "The policy number auto-generated by the framework on save and shown read-only. Mutually exclusive with the manual policy-number flavor.",
      "defaultSelected": false,
      "group": "policy-number",
      "alwaysOn": false
    },
    {
      "id": "single-exposure",
      "label": "Single Exposure",
      "description": "Exposure representation: one embedded exposures list per record with a calculated primary insured. Pair with a rater. Mutually exclusive with Standalone Primary Insured.",
      "defaultSelected": true,
      "group": "exposure-scheme",
      "alwaysOn": false
    },
    {
      "id": "standalone-primary-insured",
      "label": "Standalone Primary Insured",
      "description": "Exposure representation: a written primary insured plus additional standalone exposures. A self-contained no-rating scheme; mutually exclusive with Single Exposure and both raters.",
      "defaultSelected": false,
      "group": "exposure-scheme",
      "alwaysOn": false
    },
    {
      "id": "no-rater-billing",
      "label": "No-Rater Billing",
      "description": "A hardcoded default billing object for configurations without a rater. Mutually exclusive with Default Rater and Example Rater.",
      "defaultSelected": false,
      "group": "feature",
      "alwaysOn": false
    }
  ]
}

Seeding

List Seed Options

Lists the seed selection surface: the valid starterSheet variants accepted by the seed and seed/generate endpoints — each with a human-readable description and a marker for the one applied when starterSheet is omitted — AND the full starter-module catalog (#3428) for the explicit modules selection on seed. Each module carries its axis group, whether it is in the default selection, and whether it is always on.

Both lists are sourced from a single in-code registry/catalog, so this discovery surface can never drift from the names and module ids the seed endpoints actually accept. Use it to discover the valid values before calling seed or seed/generate, instead of probing with a bogus name and reading the 400.

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.

GET

api

companies

{companyId}

configuration

seed

options

List Seed Options

curl --request GET \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/seed/options \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/configuration/seed/options', 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/seed/options",
  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: Bearer <token>"
  ],
]);

$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}/configuration/seed/options"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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}/configuration/seed/options")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "defaultStarterSheet": "single-exposure-list",
  "options": [
    {
      "name": "default-rater",
      "description": "Alias of single-exposure-list: single exposure-list modeling with the default rater. Retained for backward compatibility.",
      "isDefault": false
    },
    {
      "name": "single-exposure-list",
      "description": "Single exposure-list modeling (one embedded exposures list per record with a calculated primary insured) paired with the default rater. This is the product default applied when starterSheet is omitted.",
      "isDefault": true
    },
    {
      "name": "standalone-primary-insured",
      "description": "Standalone primary-insured modeling: a written primary insured plus additional standalone exposures. A self-contained no-rating exposure scheme that keeps its own null default rater.",
      "isDefault": false
    }
  ],
  "modules": [
    {
      "id": "core",
      "label": "Core",
      "description": "Framework-required, non-configurable rows and the canonical sheet structure. Required on every configuration.",
      "defaultSelected": true,
      "group": "always-on",
      "alwaysOn": true
    },
    {
      "id": "default",
      "label": "Default",
      "description": "Shared configurable rows that are identical regardless of exposure scheme (fields, layout, option sets, entity invariants).",
      "defaultSelected": true,
      "group": "always-on",
      "alwaysOn": true
    },
    {
      "id": "default-rater",
      "label": "Default Rater",
      "description": "The default rating setup (rating axis). Composable with an exposure scheme; mutually exclusive with Example Rater and No-Rater Billing.",
      "defaultSelected": true,
      "group": "rating",
      "alwaysOn": false
    },
    {
      "id": "example-rater",
      "label": "Example Rater",
      "description": "The same default rating setup, shipping both example rating workflows side by side. Mutually exclusive with Default Rater and No-Rater Billing.",
      "defaultSelected": false,
      "group": "rating",
      "alwaysOn": false
    },
    {
      "id": "policy-number-manual",
      "label": "Policy Number — Manual",
      "description": "The policy number entered by the user as a required text box. Mutually exclusive with the auto policy-number flavor.",
      "defaultSelected": true,
      "group": "policy-number",
      "alwaysOn": false
    },
    {
      "id": "policy-number-auto",
      "label": "Policy Number — Auto",
      "description": "The policy number auto-generated by the framework on save and shown read-only. Mutually exclusive with the manual policy-number flavor.",
      "defaultSelected": false,
      "group": "policy-number",
      "alwaysOn": false
    },
    {
      "id": "single-exposure",
      "label": "Single Exposure",
      "description": "Exposure representation: one embedded exposures list per record with a calculated primary insured. Pair with a rater. Mutually exclusive with Standalone Primary Insured.",
      "defaultSelected": true,
      "group": "exposure-scheme",
      "alwaysOn": false
    },
    {
      "id": "standalone-primary-insured",
      "label": "Standalone Primary Insured",
      "description": "Exposure representation: a written primary insured plus additional standalone exposures. A self-contained no-rating scheme; mutually exclusive with Single Exposure and both raters.",
      "defaultSelected": false,
      "group": "exposure-scheme",
      "alwaysOn": false
    },
    {
      "id": "no-rater-billing",
      "label": "No-Rater Billing",
      "description": "A hardcoded default billing object for configurations without a rater. Mutually exclusive with Default Rater and Example Rater.",
      "defaultSelected": false,
      "group": "feature",
      "alwaysOn": false
    }
  ]
}

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

Response

The valid starter variants and the default

The valid starterSheet variants — each with a description and a default marker — the default name applied when starterSheet is omitted, AND the full starter-module catalog for the explicit modules selection. All sourced from a single in-code registry/catalog, so they cannot drift from what the seed endpoints accept.

defaultStarterSheet

string

required

The variant name applied when starterSheet is omitted.

options

object[]

required

The valid starter variants, in registry order.

Show child attributes

modules

object[]

required

The selectable starter modules (checkbox granularity, #3428) a caller can pass in the modules array on POST /configuration/seed, in catalog order.

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

List Seed Options

Authorizations

Path Parameters

Response