Skip to main content
GET
/
config
/
{productId}
Get public product config
curl --request GET \
  --url https://api.example.com/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
    }
  ],
  "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
    }
  },
  "productName": "<string>",
  "linkedServices": [
    "DRIVEQUANT"
  ],
  "externalProductId": "<string>",
  "assetStartedAtLimit": {
    "min": {},
    "max": {}
  },
  "engagementDuration": {
    "amount": 123,
    "unit": "YEAR"
  },
  "listOfIntegrations": [
    "Siv"
  ],
  "customEvents": {
    "customer": [
      "<string>"
    ],
    "policy": [
      "<string>"
    ],
    "asset": [
      "<string>"
    ]
  },
  "collectivePolicyConfig": {
    "paymentLevelKey": {}
  },
  "claims": {},
  "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>"
          ]
        }
      }
    ]
  },
  "policyStopReasons": [
    {
      "reason": "<string>",
      "details": [
        "<string>"
      ],
      "appliedAtDate": "<string>",
      "appliedInFutureAllowed": true,
      "refundType": "<string>",
      "validForDuration": {
        "amount": 123,
        "unit": "YEAR"
      },
      "billUnpaidFees": true,
      "allowedTo": [
        "<string>"
      ]
    }
  ],
  "nonDelegatedConfig": {
    "quote": {
      "filter": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "orFilter": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ]
    },
    "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
            }
          ]
        }
      }
    },
    "extraction": {
      "enabled": true,
      "promptSlug": "<string>"
    },
    "compliance": {
      "enabled": true
    },
    "conversationSystemPrompt": "<string>"
  },
  "quote": {
    "availableTiers": [
      "<string>"
    ],
    "availableExcesses": [
      "<string>"
    ],
    "availablePerils": [
      {
        "id": "<string>",
        "options": [
          "<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>"
            }
          }
        ]
      }
    ]
  }
}

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
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
productName
string
required
linkedServices
enum<string>[]

Services to link to the customers

Available options:
DRIVEQUANT,
SYDIA
externalProductId
string
assetStartedAtLimit
object
engagementDuration
object
listOfIntegrations
enum<string>[]
Available options:
Siv,
Sra,
Compliance,
Sydia,
Solvability,
ExcelApiDatabase
customEvents
object
collectivePolicyConfig
object
claims
object
nonRefundableComponents
string[]
renewal
object
policyStopReasons
object[]
nonDelegatedConfig
object
ai
object

AI configuration (classification, extraction)

quote
object