List Rating Revision Form Logic
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic"
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}/configuration/rating/form-logic', 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}/configuration/rating/form-logic",
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}/configuration/rating/form-logic"
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}/configuration/rating/form-logic")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic")
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{
"items": [
{
"id": "bc6a626e-7a96-49fd-b477-2b18cf189a0d",
"ruleName": "Attach Certificate of Insurance",
"rank": 1,
"step": "policies",
"shouldAdd": {
"leftKey": "form.number",
"operator": "=",
"rightValue": "FM-0001"
}
},
{
"id": "7dc1e6fa-9f03-4b81-8f36-ee9fb5b5fde5",
"ruleName": "Attach state-specific endorsement",
"rank": 2,
"step": [
"policies",
"quotes"
],
"shouldAdd": {
"operator": "AND",
"conditions": [
{
"leftKey": "form.number",
"operator": "=",
"rightValue": "FM-0002"
},
{
"leftKey": "policy.data.state",
"operator": "=",
"rightValue": "CA"
}
]
}
}
]
}Configuration Rating Form Logic
List Rating Revision Form Logic
Returns all form-logic rules from a rating engine revision’s config JSON
(config.policyFormLogicConfigs). Rules are returned as a flat list with
no pagination.
Filtering:
ruleName- Filter by rule name (exact match, non-empty)id- Filter by rule ID (single UUID or array)
Sorting:
ruleName(default),rank- Default direction: ascending
- Ties are broken by
idascending (or descending whensortDirection=desc)
Required permission: company:read
GET
/
api
/
external
/
companies
/
{companyId}
/
configuration
/
rating
/
form-logic
List Rating Revision Form Logic
curl --request GET \
--url https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic \
--header 'Authorization: <api-key>'import requests
url = "https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic"
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}/configuration/rating/form-logic', 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}/configuration/rating/form-logic",
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}/configuration/rating/form-logic"
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}/configuration/rating/form-logic")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/configuration/rating/form-logic")
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{
"items": [
{
"id": "bc6a626e-7a96-49fd-b477-2b18cf189a0d",
"ruleName": "Attach Certificate of Insurance",
"rank": 1,
"step": "policies",
"shouldAdd": {
"leftKey": "form.number",
"operator": "=",
"rightValue": "FM-0001"
}
},
{
"id": "7dc1e6fa-9f03-4b81-8f36-ee9fb5b5fde5",
"ruleName": "Attach state-specific endorsement",
"rank": 2,
"step": [
"policies",
"quotes"
],
"shouldAdd": {
"operator": "AND",
"conditions": [
{
"leftKey": "form.number",
"operator": "=",
"rightValue": "FM-0002"
},
{
"leftKey": "policy.data.state",
"operator": "=",
"rightValue": "CA"
}
]
}
}
]
}Authorizations
API key authentication. Include your API key in the Authorization header.
Path Parameters
Company identifier
Query Parameters
The rating engine revision ID (must exist and belong to the company)
Filter to rules whose ruleName matches exactly. Must be non-empty when provided.
Minimum string length:
1Filter to a single rule ID or an array of rule IDs
Field to sort by (default ruleName)
Available options:
ruleName, rank Sort direction (default asc)
Available options:
asc, desc Response
List of form-logic rules
Show child attributes
Show child attributes
Was this page helpful?
