Get Quotes Configuration
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration', 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://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration",
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://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration"
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))
}HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration")
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{
"policyInfo": {
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"policyDescription": {
"type": "string",
"title": "Policy Description"
},
"effectiveDate": {
"type": "string",
"title": "Effective Date",
"format": "date"
},
"contactEmail": {
"type": "string",
"title": "Contact Email",
"format": "email"
},
"premium": {
"type": "number",
"title": "Annual Premium",
"format": "currency"
},
"coverageTerritory": {
"type": "string",
"title": "Coverage Territory",
"oneOf": [
{
"const": "domestic",
"title": "Domestic"
},
{
"const": "worldwide",
"title": "Worldwide"
},
{
"const": "north_america",
"title": "North America"
}
]
}
}
}
},
"exposureTypes": [
{
"value": "vehicle",
"label": "Vehicle"
},
{
"value": "property",
"label": "Property"
},
{
"value": "employee",
"label": "Employee"
}
],
"exposureRatingFields": {
"vehicle": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"vin": {
"type": "string",
"title": "VIN"
},
"make": {
"type": "string",
"title": "Make"
},
"model": {
"type": "string",
"title": "Model"
},
"year": {
"type": "integer",
"title": "Year"
}
}
},
"property": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"address": {
"type": "string",
"title": "Property Address"
},
"squareFootage": {
"type": "number",
"title": "Square Footage"
},
"constructionType": {
"type": "string",
"title": "Construction Type",
"oneOf": [
{
"const": "frame",
"title": "Frame"
},
{
"const": "masonry",
"title": "Masonry"
},
{
"const": "steel",
"title": "Steel"
}
]
}
}
}
}
}Quotes
Get Quotes Configuration
Returns a JSON Schema describing the custom fields available for the
policyInfo.data object when creating or updating quotes.
The response is a standard JSON Schema (draft 2020-12) that can be used directly with validation libraries like Ajv or Zod. This enables clients to validate quote data before submission, reducing API errors.
Required permission: company.quote:read
GET
/
api
/
external
/
companies
/
{companyId}
/
quotes
/
configuration
Get Quotes Configuration
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration', 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://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration",
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://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration"
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))
}HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/quotes/configuration")
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{
"policyInfo": {
"data": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"policyDescription": {
"type": "string",
"title": "Policy Description"
},
"effectiveDate": {
"type": "string",
"title": "Effective Date",
"format": "date"
},
"contactEmail": {
"type": "string",
"title": "Contact Email",
"format": "email"
},
"premium": {
"type": "number",
"title": "Annual Premium",
"format": "currency"
},
"coverageTerritory": {
"type": "string",
"title": "Coverage Territory",
"oneOf": [
{
"const": "domestic",
"title": "Domestic"
},
{
"const": "worldwide",
"title": "Worldwide"
},
{
"const": "north_america",
"title": "North America"
}
]
}
}
}
},
"exposureTypes": [
{
"value": "vehicle",
"label": "Vehicle"
},
{
"value": "property",
"label": "Property"
},
{
"value": "employee",
"label": "Employee"
}
],
"exposureRatingFields": {
"vehicle": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"vin": {
"type": "string",
"title": "VIN"
},
"make": {
"type": "string",
"title": "Make"
},
"model": {
"type": "string",
"title": "Model"
},
"year": {
"type": "integer",
"title": "Year"
}
}
},
"property": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"address": {
"type": "string",
"title": "Property Address"
},
"squareFootage": {
"type": "number",
"title": "Square Footage"
},
"constructionType": {
"type": "string",
"title": "Construction Type",
"oneOf": [
{
"const": "frame",
"title": "Frame"
},
{
"const": "masonry",
"title": "Masonry"
},
{
"const": "steel",
"title": "Steel"
}
]
}
}
}
}
}Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Response
Configuration for quote custom fields
Configuration response for quotes. Structure mirrors the quote request/response shape so consumers can see exactly where to use each schema when creating or updating quotes.
Show child attributes
Show child attributes
Available exposure types for this company
Show child attributes
Show child attributes
JSON Schema for rating fields per exposure type. Keys are exposure type values, values are JSON Schema objects.
Show child attributes
Show child attributes
Was this page helpful?
⌘I