Skip to main content
GET
/
admin
/
config
/
{productId}
Admin only: Get product config
curl --request GET \
  --url https://api.example.com/admin/config/{productId}
{
  "productId": "<string>",
  "type": "INDIVIDUAL",
  "generateExternalPolicyIdTrigger": "NEVER",
  "externalPolicyIdFormat": "<string>",
  "enableMta": true,
  "allowDirectSale": true,
  "allowBrokerSale": true,
  "customerFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true
    }
  ],
  "policyFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true
    }
  ],
  "assetFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true
    }
  ],
  "claimFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true
    }
  ],
  "policyAggregateFields": [
    {
      "key": "<string>",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true,
      "type": "BOOLEAN"
    }
  ],
  "customerAggregateFields": [
    {
      "key": "<string>",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true,
      "type": "BOOLEAN"
    }
  ],
  "assetAggregateFields": [
    {
      "key": "<string>",
      "role": "<string>",
      "requiredFor": "NEVER",
      "requiresOnChange": "NEVER",
      "mtaModification": "ALLOWED",
      "renewalModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ],
      "extractionSources": [
        "<string>"
      ],
      "extractionFieldKey": "<string>",
      "canBeDeleted": true,
      "type": "BOOLEAN"
    }
  ],
  "payment": {
    "allowedPaymentModes": [
      "DIRECT_DEBIT"
    ],
    "allowedPaymentMethods": [
      "card"
    ],
    "sepaMandate": {
      "mandateDocument": {
        "configName": "<string>",
        "templateId": "<string>",
        "trigger": [
          "<string>"
        ],
        "target": "<string>",
        "businessObjects": [
          "<string>"
        ],
        "provider": "CraftMyPdf",
        "documentType": "<string>",
        "filters": [
          {
            "path": "<string>",
            "operator": "equals",
            "value": "<string>"
          }
        ],
        "orFilters": [
          {
            "path": "<string>",
            "operator": "equals",
            "value": "<string>"
          }
        ],
        "enum": {
          "policyStatuses": [
            "ACTIVE",
            "PENDING",
            "SUSPENDED",
            "STOPPED"
          ],
          "assetTypes": {
            "1": "Vehicle",
            "2": "Property"
          }
        },
        "generateOnDemand": true
      },
      "reminders": {
        "delay": 1,
        "maxAttempts": 5.5
      },
      "mandateSignature": {
        "signers": [
          {
            "recipient": "BROKER",
            "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": [
      "card"
    ],
    "paymentMethodOnRecurringPayment": [
      "card"
    ],
    "paymentMethodIsOnBrokerageFirm": true
  },
  "billing": {
    "defaultConfig": {
      "frequency": "YEARLY",
      "timing": "IN_ADVANCE",
      "billAtSignature": "EARLY_PAYMENT",
      "earlyPayment": {
        "amount": 123,
        "unit": "YEAR"
      }
    },
    "availableConfigs": [
      {
        "frequency": "YEARLY",
        "timing": "IN_ADVANCE",
        "billAtSignature": "EARLY_PAYMENT",
        "earlyPayment": {
          "amount": 123,
          "unit": "YEAR"
        }
      }
    ],
    "reconcileFailedPayments": true
  },
  "commonDocuments": [
    {
      "type": "<string>"
    }
  ],
  "generatedDocuments": [
    {
      "configName": "<string>",
      "templateId": "<string>",
      "trigger": [
        "<string>"
      ],
      "target": "<string>",
      "businessObjects": [
        "<string>"
      ],
      "provider": "CraftMyPdf",
      "documentType": "<string>",
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "orFilters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "enum": {
        "policyStatuses": [
          "ACTIVE",
          "PENDING",
          "SUSPENDED",
          "STOPPED"
        ],
        "assetTypes": {
          "1": "Vehicle",
          "2": "Property"
        }
      },
      "generateOnDemand": true
    }
  ],
  "policyholderDocuments": [
    {
      "category": "<string>",
      "required": true,
      "extractionFields": [
        {
          "key": "<string>",
          "type": "<string>",
          "sides": [
            "<string>"
          ]
        }
      ],
      "compliance": [
        {
          "type": "READABLE",
          "promptSlug": "<string>",
          "requiredFields": [
            "<array>"
          ],
          "validations": [
            {
              "fieldKey": "<string>",
              "operator": "DATE_IS_AFTER",
              "reference": {
                "ref": "NOW",
                "fieldKey": "<string>",
                "value": "<string>"
              },
              "duration": {
                "amount": 123,
                "unit": "MONTH"
              },
              "pattern": "<string>",
              "expectedValue": "<string>",
              "numericValue": 123,
              "numericMin": 123,
              "numericMax": 123,
              "errorMessage": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "signature": {
    "signedDocuments": [
      {
        "signature": "VIEW",
        "type": "<string>",
        "neededForPolicySigned": true,
        "signers": [
          {
            "recipient": "BROKER",
            "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
          }
        ]
      }
    ],
    "requirePaymentMethodForNewBusiness": true,
    "reminders": {
      "delay": 1,
      "maxAttempts": 5.5
    }
  },
  "tenantName": "<string>",
  "productName": "<string>",
  "parentProductId": "<string>",
  "childProductId": "<string>",
  "featureFlag": true,
  "migratedContractsBillingStartAt": "2023-11-07T05:31:56Z",
  "migratedContractsBillingStartAtOverride": {},
  "linkedServices": [
    "DRIVEQUANT"
  ],
  "externalProductId": "<string>",
  "stopBillingPeriod": {
    "amount": 123,
    "unit": "YEAR"
  },
  "assetStartedAtLimit": {
    "min": {},
    "max": {}
  },
  "engagementDuration": {
    "amount": 123,
    "unit": "YEAR"
  },
  "periodDuration": {
    "defaultConfig": {
      "amount": 123,
      "unit": "YEAR"
    },
    "availableConfigs": [
      {
        "amount": 123,
        "unit": "YEAR"
      }
    ]
  },
  "listOfIntegrations": [
    "Siv"
  ],
  "recurringTasks": [
    {
      "name": "<string>",
      "order": 123,
      "runsOnConfigs": [
        {}
      ],
      "workflow": {}
    }
  ],
  "spotTasks": [
    {
      "trigger": [
        "<string>"
      ],
      "task": {}
    }
  ],
  "customEvents": {
    "customer": [
      "<string>"
    ],
    "policy": [
      "<string>"
    ],
    "asset": [
      "<string>"
    ]
  },
  "createUserOn": [
    "<string>"
  ],
  "individualPolicyConfig": {
    "pricing": [
      {
        "type": "ONE_TIME",
        "frequency": "YEARLY",
        "splitAt": 123
      }
    ],
    "quoteInvalidation": [
      {
        "referenceDate": "STARTED_AT",
        "duration": {
          "amount": 123,
          "unit": "YEAR"
        }
      }
    ],
    "startOnSignature": true,
    "quote": {
      "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>"
              }
            }
          ]
        }
      ],
      "pricing": [
        {
          "type": "EXCEL_API_SPREADSHEET",
          "name": "<string>",
          "fileId": "<string>",
          "inputs": [
            "<array>"
          ],
          "policyComponents": [
            {
              "id": "<string>",
              "type": "PREMIUM",
              "chargeType": "ONE_TIME",
              "premium": {}
            }
          ],
          "assetComponents": [
            "<array>"
          ],
          "condition": {
            "entity": "<string>",
            "fieldKey": "<string>",
            "value": "<string>"
          },
          "outputs": [
            "<string>"
          ]
        }
      ]
    },
    "allowedTotalCommissionFee": {
      "min": 50,
      "max": 50,
      "default": 50
    }
  },
  "collectivePolicyConfig": {
    "paymentLevelKey": {}
  },
  "claims": {},
  "branchSubTypes": {
    "BASE": [
      "<string>"
    ],
    "NEW_BUSINESS": [
      "<string>"
    ],
    "MTA": [
      "<string>"
    ],
    "RENEWAL": [
      "<string>"
    ],
    "REPRICING": [
      "<string>"
    ]
  },
  "unpaid": {
    "components": [
      {
        "id": "<string>",
        "type": "PREMIUM",
        "chargeType": "ONE_TIME",
        "amountPreFeesAndTaxes": 123,
        "fees": [
          {
            "id": "<string>",
            "chargeType": "ONE_TIME",
            "amount": 123,
            "brokerageFirmId": "<string>"
          }
        ],
        "taxes": [
          {
            "id": "<string>",
            "chargeType": "ONE_TIME",
            "amount": 123
          }
        ]
      }
    ],
    "notifications": [
      {
        "notificationIndex": 123,
        "durationSinceFailure": {
          "amount": 123,
          "unit": "YEAR"
        },
        "trigger": "<string>",
        "sendIfPriorUnpaidInvoice": true
      }
    ]
  },
  "nonRefundableComponents": [
    "<string>"
  ],
  "renewal": {
    "__type": "ConfigRenewalEnabled",
    "enabled": true,
    "renewalPeriod": {
      "amount": 123,
      "unit": "YEAR"
    },
    "cancellationConfigs": [
      {
        "trigger": "RENEWAL_REFUSED",
        "closeBranchReason": "BROKER_REQUEST",
        "policyStopReason": "<string>",
        "policyStopDetails": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "tacitRenewal": true,
    "crmParameters": {
      "usage": "TOURING_OR_ALL_PURPOSE",
      "crmLimit": 123
    },
    "renewalFees": [
      {
        "id": "<string>",
        "component": {
          "id": "<string>",
          "type": "PREMIUM",
          "premium": {
            "amountPreFeesAndTaxes": 123,
            "fees": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123,
                "brokerageFirmId": "<string>"
              }
            ],
            "totalFees": 123,
            "amountWithFeesPreTaxes": 123,
            "taxes": [
              {
                "id": "<string>",
                "chargeType": "ONE_TIME",
                "amount": 123
              }
            ],
            "totalTaxes": 123,
            "amountWithFeesAndTaxes": 123
          },
          "chargeType": "ONE_TIME"
        },
        "applyOnEveryRenewal": true,
        "condition": {
          "tier": "<string>",
          "excess": "<string>",
          "perils": [
            "<string>"
          ]
        }
      }
    ]
  },
  "repricing": {
    "repricingPeriod": {
      "amount": 123,
      "unit": "YEAR"
    },
    "drivequantScoreOptions": {
      "key": "<string>",
      "value": "<string>"
    }
  },
  "emailsConfig": {
    "bccEmail": [
      "<string>"
    ]
  },
  "emails": [
    {
      "trigger": "<string>",
      "templateId": "<string>",
      "sendTo": [
        {
          "recipient": "<string>",
          "roles": [
            "<string>"
          ]
        }
      ],
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "attachments": [
        {
          "type": "<string>",
          "signed": true
        }
      ],
      "payload": {
        "businessObjects": [
          "<string>"
        ],
        "target": "<string>"
      },
      "calculate": [
        "<string>"
      ],
      "messageData": [
        {
          "key": "<string>",
          "path": "<string>",
          "mapping": {},
          "format": "<string>",
          "dateFormat": "<string>"
        }
      ]
    }
  ],
  "policyStopReasons": [
    {
      "reason": "<string>",
      "details": [
        "<string>"
      ],
      "appliedAtDate": "<string>",
      "appliedInFutureAllowed": true,
      "refundType": "<string>",
      "validForDuration": {
        "amount": 123,
        "unit": "YEAR"
      },
      "billUnpaidFees": true,
      "allowedTo": [
        "<string>"
      ]
    }
  ],
  "fees": {
    "compensateWith": "WHOLESALE_FEE",
    "defaults": {
      "retail": {
        "minCommission": 50,
        "maxCommission": 50,
        "defaultCommission": 50,
        "minCommissionLimit": 50,
        "maxCommissionLimit": 50,
        "minTotalCommission": 50,
        "maxTotalCommission": 50,
        "minManagementFee": 1,
        "maxManagementFee": 1
      },
      "wholesale": {
        "minCommission": 50,
        "maxCommission": 50,
        "defaultCommission": 50,
        "minCommissionLimit": 50,
        "maxCommissionLimit": 50,
        "minTotalCommission": 50,
        "maxTotalCommission": 50,
        "minManagementFee": 1,
        "maxManagementFee": 1
      }
    }
  },
  "migration": {
    "quoteComponents": [
      "<string>"
    ],
    "policyInternalIdMigrationEnabled": true
  },
  "integrations": [
    {
      "enabled": true,
      "target": "<string>",
      "name": "<string>",
      "provider": "<string>",
      "entityType": "ASSET",
      "inputKeys": [
        {
          "inputKey": "<string>",
          "customField": "<string>",
          "required": true
        }
      ],
      "outputKeys": [
        {
          "outputKey": "<string>",
          "customField": "<string>"
        }
      ],
      "disabledOnBranchTypes": [
        "<string>"
      ]
    }
  ],
  "nonDelegatedConfig": {
    "quote": {
      "filter": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "orFilter": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ]
    },
    "documents": {
      "documentTypes": [
        "<string>"
      ]
    }
  },
  "maxAssets": 2,
  "derogationBranches": [
    "<string>"
  ],
  "derogation": [
    {
      "branchType": "BASE",
      "actions": [
        {
          "action": "QUOTE",
          "filter": [
            {
              "path": "<string>",
              "operator": "equals",
              "value": "<string>"
            }
          ],
          "orFilter": [
            {
              "path": "<string>",
              "operator": "equals",
              "value": "<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
            }
          ]
        }
      }
    },
    "extraction": {
      "enabled": true,
      "promptSlug": "<string>"
    },
    "compliance": {
      "enabled": true
    },
    "conversationSystemPrompt": "<string>"
  },
  "priceBreakdown": {},
  "quoteConfig": {}
}

Path Parameters

​
productId
string
required

Response

​
productId
string
required
​
type
enum<string>
required
Available options:
INDIVIDUAL,
COLLECTIVE
​
generateExternalPolicyIdTrigger
enum<string>
required
Available options:
NEVER,
CREATION,
QUOTE,
CONFIRMATION,
SIGNATURE,
NOTHING
​
externalPolicyIdFormat
string
required
​
enableMta
boolean
required
​
allowDirectSale
boolean
required
​
allowBrokerSale
boolean
required
​
customerFields
object[]
required
​
policyFields
object[]
required
​
assetFields
object[]
required
​
claimFields
object[]
required
​
policyAggregateFields
object[]
required
​
customerAggregateFields
object[]
required
​
assetAggregateFields
object[]
required
​
payment
object
required
​
billing
object
required
​
commonDocuments
object[]
required
​
generatedDocuments
object[]
required
​
policyholderDocuments
object[]
required
​
signature
object
required
​
tenantName
string
required
​
productName
string
required
​
parentProductId
string
​
childProductId
string
​
featureFlag
boolean
​
migratedContractsBillingStartAt
string<date-time>
​
migratedContractsBillingStartAtOverride
object
​
linkedServices
enum<string>[]

Services to link to the customers

Available options:
DRIVEQUANT,
SYDIA
​
externalProductId
string
​
stopBillingPeriod
object
​
assetStartedAtLimit
object
​
engagementDuration
object
​
periodDuration
object
​
listOfIntegrations
enum<string>[]
Available options:
Siv,
Sra,
Compliance,
Sydia,
Solvability,
ExcelApiDatabase
​
recurringTasks
object[]
​
spotTasks
object[]
​
customEvents
object
​
createUserOn
string[]
​
individualPolicyConfig
object
​
collectivePolicyConfig
object
​
claims
object
​
branchSubTypes
object
​
unpaid
object
​
nonRefundableComponents
string[]
​
renewal
object
​
repricing
object
​
emailsConfig
object

Emails specific configuration

​
emails
object[]
​
policyStopReasons
object[]
​
fees
object
​
migration
object
​
integrations
object[]
​
nonDelegatedConfig
object
​
maxAssets
number

Maximum number of assets allowed per policy

Required range: x >= 1
​
derogationBranches
string[]
​
derogation
object[]
​
ai
object

AI configuration (classification, extraction)

​
priceBreakdown
object

Declarative display line formulas for price breakdown rendering.

​
quoteConfig
object

Configuration-driven quote system. When defined, replaces legacy per-product quote engines.