Skip to main content
GET
/
admin
/
config
/
{productId}
{
  "productId": "<string>",
  "type": "INDIVIDUAL",
  "generateExternalPolicyIdTrigger": "CREATION",
  "externalPolicyIdFormat": "<string>",
  "enableMta": true,
  "allowDirectSale": true,
  "allowBrokerSale": true,
  "customerFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "policyFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "assetFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "claimFields": [
    {
      "key": "<string>",
      "type": "BOOLEAN",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "policyAggregateFields": [
    {
      "key": "<string>",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "customerAggregateFields": [
    {
      "key": "<string>",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "assetAggregateFields": [
    {
      "key": "<string>",
      "role": "<string>",
      "requiredFor": "CREATION",
      "requiresOnChange": "CREATION",
      "mtaModification": "ALLOWED",
      "validationRules": [
        {
          "option": "<string>",
          "value": "<string>"
        }
      ],
      "isCalculated": true,
      "integrationKey": "<string>",
      "defaultValue": {},
      "updatesOn": [
        "<string>"
      ]
    }
  ],
  "payment": {
    "allowedPaymentModes": [
      "DIRECT_DEBIT"
    ],
    "allowedPaymentMethods": [
      "card"
    ],
    "sepaMandate": {
      "mandateDocument": {
        "configName": "<string>",
        "templateId": "<string>",
        "trigger": [
          "<string>"
        ],
        "target": "<string>",
        "businessObjects": [
          "<string>"
        ],
        "documentType": "<string>",
        "filters": [
          {
            "path": "<string>",
            "operator": "equals",
            "value": "<string>"
          }
        ]
      },
      "reminders": {
        "delay": 1,
        "maxAttempts": 5.5
      },
      "mandateSignature": {
        "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",
      "reconciliationMethod": "INSTANT",
      "timing": "IN_ADVANCE",
      "billAtSignature": "EARLY_PAYMENT",
      "spread": "DYNAMIC",
      "earlyPayment": {
        "amount": 123,
        "unit": "YEAR"
      }
    },
    "availableConfigs": [
      {
        "frequency": "YEARLY",
        "reconciliationMethod": "INSTANT",
        "timing": "IN_ADVANCE",
        "billAtSignature": "EARLY_PAYMENT",
        "spread": "DYNAMIC",
        "earlyPayment": {
          "amount": 123,
          "unit": "YEAR"
        }
      }
    ],
    "reconcileFailedPayments": true
  },
  "commonDocuments": [
    {
      "type": "<string>"
    }
  ],
  "generatedDocuments": [
    {
      "configName": "<string>",
      "templateId": "<string>",
      "trigger": [
        "<string>"
      ],
      "target": "<string>",
      "businessObjects": [
        "<string>"
      ],
      "documentType": "<string>",
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ]
    }
  ],
  "signature": {
    "signer": {
      "entity": "<string>",
      "customFieldKeys": {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>"
      },
      "useAuthorAsRecipient": true
    },
    "signedDocuments": [
      {
        "signature": "VIEW",
        "type": "<string>",
        "signPolicy": 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>",
  "derogationBranches": [
    "<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>",
      "runsOnConfigs": [
        {}
      ],
      "workflow": {}
    }
  ],
  "spotTasks": [
    {
      "trigger": [
        "<string>"
      ],
      "task": {}
    }
  ],
  "grantConfigs": [
    {
      "inviteType": "COMPANY",
      "tokenType": "ONE_TIME",
      "relationsToCreate": [
        {
          "relationType": "<string>"
        }
      ],
      "tokenExpiration": "<string>",
      "usesBranch": true,
      "forceSendEmail": true
    }
  ],
  "customEvents": {
    "customer": [
      "<string>"
    ],
    "policy": [
      "<string>"
    ],
    "asset": [
      "<string>"
    ]
  },
  "individualPolicyConfig": {
    "pricing": [
      {
        "type": "ONE_TIME",
        "frequency": "YEARLY",
        "splitAt": 123
      }
    ],
    "quoteInvalidation": {
      "allowSignatureAfterBranchStartAt": true,
      "maxQuoteValidityPeriodInDays": 123
    },
    "startOnSignature": true,
    "quote": {
      "availableTiers": [
        {
          "id": "<string>",
          "label": "<string>"
        }
      ],
      "availableExcesses": [
        {
          "id": "<string>",
          "label": "<string>"
        }
      ],
      "availablePerils": [
        {
          "id": "<string>",
          "label": "<string>",
          "options": [
            "<string>"
          ]
        }
      ],
      "defaultConfig": {
        "tier": "<string>",
        "excess": "<string>",
        "perils": [
          {
            "id": "<string>",
            "option": "<string>"
          }
        ]
      },
      "availableConfigs": [
        {
          "tier": "<string>",
          "excess": "<string>",
          "perils": [
            {
              "id": "<string>",
              "required": true,
              "options": [
                "<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": {},
  "repricing": {
    "repricingPeriod": {
      "amount": 123,
      "unit": "YEAR"
    },
    "drivequantScoreOptions": {
      "key": "<string>",
      "value": "<string>"
    }
  },
  "emailsConfig": {
    "bccEmail": [
      "<string>"
    ]
  },
  "emails": [
    {
      "trigger": "<string>",
      "templateId": "<string>",
      "filters": [
        {
          "path": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "receiverEmail": {
        "useCustomerContactEmail": true
      },
      "brokerEmail": {
        "useBrokerageFirmOwnerEmail": true,
        "roleId": "<string>"
      },
      "attachments": [
        {
          "type": "<string>",
          "signed": true
        }
      ],
      "payload": {
        "businessObjects": [
          "<string>"
        ],
        "target": "<string>"
      },
      "calculate": [
        "<string>"
      ],
      "messageData": [
        {
          "key": "<string>",
          "path": "<string>",
          "mapping": {},
          "format": "<string>",
          "dateFormat": "<string>"
        }
      ]
    }
  ],
  "emailsV2": [
    {
      "trigger": "<string>",
      "templateId": "<string>",
      "sendTo": [
        {
          "recipient": "<string>",
          "roles": [
            "<string>"
          ],
          "relations": [
            "<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"
      }
    }
  ],
  "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>"
        }
      ]
    }
  ],
  "nonDelegatedConfig": {
    "quote": {
      "filter": [
        "<string>"
      ]
    },
    "documents": {
      "documentTypes": [
        "<string>"
      ]
    }
  },
  "maxAssets": 2
}

Path Parameters

productId
string
required

Response

productId
string
required
type
enum<string>
required
Available options:
INDIVIDUAL,
COLLECTIVE
generateExternalPolicyIdTrigger
enum<string>
required
Available options:
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
signature
object
required
tenantName
string
required
productName
string
required
parentProductId
string
derogationBranches
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
recurringTasks
object[]
spotTasks
object[]
grantConfigs
object[]

Grant configurations

customEvents
object
individualPolicyConfig
object
collectivePolicyConfig
object
claims
object
branchSubTypes
object
unpaid
object
nonRefundableComponents
string[]
renewal
object
repricing
object
emailsConfig
object

Emails specific configuration

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

Maximum number of assets allowed per policy

Required range: x >= 1