curl --request GET \
--url https://api.korint.io/config/{productId} \
--header 'Authorization: Bearer <token>' \
--header 'tenant: <tenant>'import requests
url = "https://api.korint.io/config/{productId}"
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {tenant: '<tenant>', Authorization: 'Bearer <token>'}};
fetch('https://api.korint.io/config/{productId}', 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://api.korint.io/config/{productId}",
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>",
"tenant: <tenant>"
],
]);
$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://api.korint.io/config/{productId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("tenant", "<tenant>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.korint.io/config/{productId}")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/config/{productId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"productId": "<string>",
"type": "INDIVIDUAL",
"externalPolicyIdFormat": "<string>",
"enableMta": true,
"allowDirectSale": true,
"allowBrokerSale": true,
"customerFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"policyFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"assetFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"policyAggregateFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"customerAggregateFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"assetAggregateFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"payment": {
"allowedPaymentModes": [],
"allowedPaymentMethods": [],
"sepaMandate": {
"mandateDocument": {
"configName": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"templateId": "<string>",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"value": "<string>"
}
],
"generateOnDemand": true,
"resolveExternalQuotes": true,
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
}
},
"reminders": {
"maxAttempts": 5.5
},
"mandateSignature": {
"configName": "<string>",
"signers": [
{
"role": "<string>",
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
]
}
],
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
]
}
},
"paymentMethodOnEarlyPayment": [],
"paymentMethodOnRecurringPayment": [],
"paymentMethodOnBrokenMethod": [],
"paymentMethodIsOnBrokerageFirm": true
},
"billing": {
"defaultConfig": {
"earlyPayment": {
"amount": 123
}
},
"availableConfigs": [
{
"earlyPayment": {
"amount": 123
}
}
],
"billingAssignment": {
"defaultConfig": {
"id": "<string>",
"defaultPayerRole": "<string>",
"componentOverrides": [
{
"componentId": "<string>",
"payerRole": "<string>"
}
],
"filter": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilter": [
{
"path": "<string>",
"value": "<string>"
}
]
},
"availableConfigs": [
{
"id": "<string>",
"defaultPayerRole": "<string>",
"componentOverrides": [
{
"componentId": "<string>",
"payerRole": "<string>"
}
],
"filter": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilter": [
{
"path": "<string>",
"value": "<string>"
}
]
}
]
},
"reconcileFailedPayments": true
},
"commonDocuments": [
{
"type": "<string>"
}
],
"generatedDocuments": [
{
"configName": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"templateId": "<string>",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"value": "<string>"
}
],
"generateOnDemand": true,
"resolveExternalQuotes": true,
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
}
}
],
"policyholderDocuments": [
{
"category": "<string>",
"required": true,
"extractionFields": [
{
"key": "<string>",
"type": "<string>",
"sides": [
"<string>"
]
}
],
"validity": [
{
"promptSlug": "<string>",
"requiredFields": [
"<array>"
],
"validations": [
{
"fieldKey": "<string>",
"reference": {
"fieldKey": "<string>",
"value": "<string>"
},
"duration": {
"amount": 123
},
"pattern": "<string>",
"expectedValue": "<string>",
"numericValue": 123,
"numericMin": 123,
"numericMax": 123,
"errorMessage": "<string>"
}
]
}
]
}
],
"signature": {
"signedDocuments": [
{
"type": "<string>",
"neededForPolicySigned": true,
"configName": "<string>",
"signers": [
{
"role": "<string>",
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
]
}
],
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
],
"branchTypes": []
}
],
"requirePaymentMethodForNewBusiness": true,
"reminders": {
"maxAttempts": 5.5
}
},
"productName": "<string>",
"isFormalNoticeEnabled": true,
"linkedServices": [],
"externalProductId": "<string>",
"requireFirstPaymentToActivate": true,
"assetStartedAtLimit": {
"min": {},
"max": {}
},
"engagementDuration": {
"amount": 123
},
"listOfIntegrations": [],
"customEvents": {
"customer": [
"<string>"
],
"policy": [
"<string>"
],
"asset": [
"<string>"
]
},
"claims": {},
"nonRefundableComponents": [
"<string>"
],
"renewal": {
"__type": "ConfigRenewalEnabled",
"enabled": true,
"renewalPeriod": {
"amount": 123
},
"cancellationConfigs": [
{
"policyStopReason": "<string>",
"policyStopDetails": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"tacitRenewal": true,
"crmParameters": {
"crmLimit": 123
},
"renewalFees": [
{
"id": "<string>",
"component": {
"id": "<string>",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
}
},
"applyOnEveryRenewal": true,
"condition": {
"tier": "<string>",
"excess": "<string>",
"perils": [
"<string>"
]
}
}
]
},
"claimDocuments": [
{
"category": "<string>",
"required": true,
"extractionFields": [
{
"key": "<string>",
"type": "<string>",
"sides": [
"<string>"
]
}
],
"validity": [
{
"promptSlug": "<string>",
"requiredFields": [
"<array>"
],
"validations": [
{
"fieldKey": "<string>",
"reference": {
"fieldKey": "<string>",
"value": "<string>"
},
"duration": {
"amount": 123
},
"pattern": "<string>",
"expectedValue": "<string>",
"numericValue": 123,
"numericMin": 123,
"numericMax": 123,
"errorMessage": "<string>"
}
]
}
]
}
],
"policyStopReasons": [
{
"reason": "<string>",
"details": [
"<string>"
],
"appliedAtDate": "<string>",
"appliedInFutureAllowed": true,
"refundType": "<string>",
"validForDuration": {
"amount": 123
},
"billUnpaidFees": true,
"allowedTo": [
"<string>"
]
}
],
"nonDelegatedConfig": {
"quote": {
"filter": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilter": [
{
"path": "<string>",
"value": "<string>"
}
],
"branchTypes": []
},
"documents": {
"documentTypes": [
"<string>"
]
}
},
"ai": {
"classification": {
"enabled": true,
"interfaces": {
"policyholderDashboard": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
},
"brokerageFirmDocuments": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
},
"nonDelegatedDocuments": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
},
"fnolDocuments": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
}
}
},
"extraction": {
"enabled": true,
"promptSlug": "<string>"
},
"validity": {
"enabled": true
},
"autofill": {
"enabled": true
},
"claimDocClassifier": {
"enabled": true,
"classificationPromptSlug": "<string>",
"claimDocCodeToCategory": {}
},
"claimDocExtractor": {
"enabled": true,
"promptSlug": "<string>"
},
"conversationSystemPrompt": "<string>"
},
"publicQuoteConfig": {
"productId": "<string>",
"defaultTier": "<string>",
"tiers": [
{
"id": "<string>",
"manualComponents": [
{
"id": "<string>",
"required": true,
"editableFor": [],
"referenceComponentIds": [
"<string>"
],
"referenceAmountFields": [
"<string>"
]
}
]
}
]
},
"quote": {
"availableTiers": [
"<string>"
],
"availableExcesses": [
"<string>"
],
"availablePerils": [
{
"id": "<string>",
"options": [
"<string>"
],
"customFields": [
"<string>"
]
}
],
"defaultConfig": {
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"option": "<string>",
"available": true,
"unavailabilityMessage": "<string>"
}
]
},
"availableConfigs": [
{
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"required": true,
"options": [
"<string>"
],
"showWhen": {
"fieldKey": "<string>",
"fieldValue": "<string>",
"condition": "<string>",
"value": "<string>"
}
}
]
}
]
},
"usesQuoteConfig": true
}{
"code": "INVALID_PRODUCT",
"message": "Invalid product {product}",
"details": {}
}Get public product config
Read this at runtime before every journey — products gain fields, and a transcribed list silently stops matching. Fields from the *AggregateFields lists are top-level properties of their entity; the rest go in its customFields array.
curl --request GET \
--url https://api.korint.io/config/{productId} \
--header 'Authorization: Bearer <token>' \
--header 'tenant: <tenant>'import requests
url = "https://api.korint.io/config/{productId}"
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {tenant: '<tenant>', Authorization: 'Bearer <token>'}};
fetch('https://api.korint.io/config/{productId}', 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://api.korint.io/config/{productId}",
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>",
"tenant: <tenant>"
],
]);
$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://api.korint.io/config/{productId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("tenant", "<tenant>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.korint.io/config/{productId}")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/config/{productId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"productId": "<string>",
"type": "INDIVIDUAL",
"externalPolicyIdFormat": "<string>",
"enableMta": true,
"allowDirectSale": true,
"allowBrokerSale": true,
"customerFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"policyFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"assetFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"policyAggregateFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"customerAggregateFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"assetAggregateFields": [
{
"key": "<string>",
"role": "<string>",
"validationRules": [
{
"option": "<string>",
"value": "<string>"
}
],
"isCalculated": true,
"integrationKey": "<string>",
"defaultValue": {},
"updatesOn": [
"<string>"
],
"extractionSources": [
"<string>"
],
"extractionFieldKey": "<string>",
"autoFill": {
"enabled": true
},
"canBeDeleted": true
}
],
"payment": {
"allowedPaymentModes": [],
"allowedPaymentMethods": [],
"sepaMandate": {
"mandateDocument": {
"configName": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"templateId": "<string>",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"value": "<string>"
}
],
"generateOnDemand": true,
"resolveExternalQuotes": true,
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
}
},
"reminders": {
"maxAttempts": 5.5
},
"mandateSignature": {
"configName": "<string>",
"signers": [
{
"role": "<string>",
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
]
}
],
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
]
}
},
"paymentMethodOnEarlyPayment": [],
"paymentMethodOnRecurringPayment": [],
"paymentMethodOnBrokenMethod": [],
"paymentMethodIsOnBrokerageFirm": true
},
"billing": {
"defaultConfig": {
"earlyPayment": {
"amount": 123
}
},
"availableConfigs": [
{
"earlyPayment": {
"amount": 123
}
}
],
"billingAssignment": {
"defaultConfig": {
"id": "<string>",
"defaultPayerRole": "<string>",
"componentOverrides": [
{
"componentId": "<string>",
"payerRole": "<string>"
}
],
"filter": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilter": [
{
"path": "<string>",
"value": "<string>"
}
]
},
"availableConfigs": [
{
"id": "<string>",
"defaultPayerRole": "<string>",
"componentOverrides": [
{
"componentId": "<string>",
"payerRole": "<string>"
}
],
"filter": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilter": [
{
"path": "<string>",
"value": "<string>"
}
]
}
]
},
"reconcileFailedPayments": true
},
"commonDocuments": [
{
"type": "<string>"
}
],
"generatedDocuments": [
{
"configName": "<string>",
"trigger": [
"<string>"
],
"target": "<string>",
"businessObjects": [
"<string>"
],
"templateId": "<string>",
"documentType": "<string>",
"filters": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilters": [
{
"path": "<string>",
"value": "<string>"
}
],
"generateOnDemand": true,
"resolveExternalQuotes": true,
"enum": {
"policyStatuses": [
"ACTIVE",
"PENDING",
"SUSPENDED",
"STOPPED"
],
"assetTypes": {
"1": "Vehicle",
"2": "Property"
}
}
}
],
"policyholderDocuments": [
{
"category": "<string>",
"required": true,
"extractionFields": [
{
"key": "<string>",
"type": "<string>",
"sides": [
"<string>"
]
}
],
"validity": [
{
"promptSlug": "<string>",
"requiredFields": [
"<array>"
],
"validations": [
{
"fieldKey": "<string>",
"reference": {
"fieldKey": "<string>",
"value": "<string>"
},
"duration": {
"amount": 123
},
"pattern": "<string>",
"expectedValue": "<string>",
"numericValue": 123,
"numericMin": 123,
"numericMax": 123,
"errorMessage": "<string>"
}
]
}
]
}
],
"signature": {
"signedDocuments": [
{
"type": "<string>",
"neededForPolicySigned": true,
"configName": "<string>",
"signers": [
{
"role": "<string>",
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
]
}
],
"anchor": {
"page": {},
"x": 123,
"y": 123,
"height": 123,
"width": 123
},
"mentions": [
{
"page": {},
"x": 123,
"y": 123,
"mention": "<string>",
"width": 123
}
],
"texts": [
{
"page": {},
"x": 123,
"y": 123,
"width": 123,
"maxLength": 123,
"question": "<string>",
"height": 123,
"instruction": "<string>",
"optional": true
}
],
"checkboxes": [
{
"page": {},
"x": 123,
"y": 123,
"size": 123,
"name": "<string>",
"optional": true,
"checked": true
}
],
"branchTypes": []
}
],
"requirePaymentMethodForNewBusiness": true,
"reminders": {
"maxAttempts": 5.5
}
},
"productName": "<string>",
"isFormalNoticeEnabled": true,
"linkedServices": [],
"externalProductId": "<string>",
"requireFirstPaymentToActivate": true,
"assetStartedAtLimit": {
"min": {},
"max": {}
},
"engagementDuration": {
"amount": 123
},
"listOfIntegrations": [],
"customEvents": {
"customer": [
"<string>"
],
"policy": [
"<string>"
],
"asset": [
"<string>"
]
},
"claims": {},
"nonRefundableComponents": [
"<string>"
],
"renewal": {
"__type": "ConfigRenewalEnabled",
"enabled": true,
"renewalPeriod": {
"amount": 123
},
"cancellationConfigs": [
{
"policyStopReason": "<string>",
"policyStopDetails": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"tacitRenewal": true,
"crmParameters": {
"crmLimit": 123
},
"renewalFees": [
{
"id": "<string>",
"component": {
"id": "<string>",
"premium": {
"amountPreFeesAndTaxes": 123,
"fees": [
{
"id": "<string>",
"amount": 123,
"brokerageFirmId": "<string>"
}
],
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"taxes": [
{
"id": "<string>",
"amount": 123
}
],
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
}
},
"applyOnEveryRenewal": true,
"condition": {
"tier": "<string>",
"excess": "<string>",
"perils": [
"<string>"
]
}
}
]
},
"claimDocuments": [
{
"category": "<string>",
"required": true,
"extractionFields": [
{
"key": "<string>",
"type": "<string>",
"sides": [
"<string>"
]
}
],
"validity": [
{
"promptSlug": "<string>",
"requiredFields": [
"<array>"
],
"validations": [
{
"fieldKey": "<string>",
"reference": {
"fieldKey": "<string>",
"value": "<string>"
},
"duration": {
"amount": 123
},
"pattern": "<string>",
"expectedValue": "<string>",
"numericValue": 123,
"numericMin": 123,
"numericMax": 123,
"errorMessage": "<string>"
}
]
}
]
}
],
"policyStopReasons": [
{
"reason": "<string>",
"details": [
"<string>"
],
"appliedAtDate": "<string>",
"appliedInFutureAllowed": true,
"refundType": "<string>",
"validForDuration": {
"amount": 123
},
"billUnpaidFees": true,
"allowedTo": [
"<string>"
]
}
],
"nonDelegatedConfig": {
"quote": {
"filter": [
{
"path": "<string>",
"value": "<string>"
}
],
"orFilter": [
{
"path": "<string>",
"value": "<string>"
}
],
"branchTypes": []
},
"documents": {
"documentTypes": [
"<string>"
]
}
},
"ai": {
"classification": {
"enabled": true,
"interfaces": {
"policyholderDashboard": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
},
"brokerageFirmDocuments": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
},
"nonDelegatedDocuments": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
},
"fnolDocuments": {
"enabled": true,
"systemPromptSlug": "<string>",
"judgePromptSlug": "<string>",
"judges": [
{
"model": "<string>",
"enabled": true
}
]
}
}
},
"extraction": {
"enabled": true,
"promptSlug": "<string>"
},
"validity": {
"enabled": true
},
"autofill": {
"enabled": true
},
"claimDocClassifier": {
"enabled": true,
"classificationPromptSlug": "<string>",
"claimDocCodeToCategory": {}
},
"claimDocExtractor": {
"enabled": true,
"promptSlug": "<string>"
},
"conversationSystemPrompt": "<string>"
},
"publicQuoteConfig": {
"productId": "<string>",
"defaultTier": "<string>",
"tiers": [
{
"id": "<string>",
"manualComponents": [
{
"id": "<string>",
"required": true,
"editableFor": [],
"referenceComponentIds": [
"<string>"
],
"referenceAmountFields": [
"<string>"
]
}
]
}
]
},
"quote": {
"availableTiers": [
"<string>"
],
"availableExcesses": [
"<string>"
],
"availablePerils": [
{
"id": "<string>",
"options": [
"<string>"
],
"customFields": [
"<string>"
]
}
],
"defaultConfig": {
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"option": "<string>",
"available": true,
"unavailabilityMessage": "<string>"
}
]
},
"availableConfigs": [
{
"tier": "<string>",
"excess": "<string>",
"perils": [
{
"id": "<string>",
"required": true,
"options": [
"<string>"
],
"showWhen": {
"fieldKey": "<string>",
"fieldValue": "<string>",
"condition": "<string>",
"value": "<string>"
}
}
]
}
]
},
"usesQuoteConfig": true
}{
"code": "INVALID_PRODUCT",
"message": "Invalid product {product}",
"details": {}
}Authorizations
Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.
Headers
Your tenant identifier. Requests without it are rejected.
Path Parameters
Response
INDIVIDUAL NEVER, CREATION, QUOTE, CONFIRMATION, SIGNATURE, NOTHING Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether AR24 formal notice (mise en demeure) is enabled for this product.
Services to link to the customers
DRIVEQUANT, SYDIA When true, a signed contract only comes into force once the first premium has been collected, in addition to reaching its start date. When false or absent, the start date alone brings it into force.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Siv, Sra, Compliance, Sydia, Solvability, ExcelApiDatabase Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
AI configuration (classification, extraction)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
True when the product uses the new quoteConfig format (tier-based perils). False/absent for legacy individualPolicyConfig.quote products.
Was this page helpful?

