Download OpenAPI specification:Download
Contains functionality around insurance product configuration.
For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.
Returns all available global reference values.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "referenceValues": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}
]
}Returns all available global rules.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "rules": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
]
}Returns all available global composite rules.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "compositeRules": [
- {
- "code": "string",
- "groupCode": "string",
- "name": "string",
- "isActive": true,
- "createDate": "2026-03-25T10:13:57Z",
- "dependentRules": [
- "string"
], - "expression": "string"
}
]
}Retrieve all available global parameters.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "globalParameter": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}
}Retrieve all available global composite parameters.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "globalParameter": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}
}Retrieve all available lookups
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "lookups": [
- {
- "listKey": "string",
- "listItems": [
- {
- "id": 0,
- "uid": "string",
- "label": "string",
- "key": "string",
- "customAttributes": "string"
}
]
}
]
}Retrieve all available global parameters merged with schema parameters
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "parameters": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}
}Retrieve all available global composite parameters merged with schema composite parameters
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "compositeParameters": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}
}Retrieve all available global data that is being requested.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Defines data that should be returned
| getCompositeParameters | boolean |
| getParameters | boolean |
| getReferenceValues | boolean |
| getRules | boolean |
| getCompositeRules | boolean |
| getLookups | boolean |
| getMergedParameters | boolean |
| getMergedCompositeParameters | boolean |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "getCompositeParameters": true,
- "getParameters": true,
- "getReferenceValues": true,
- "getRules": true,
- "getCompositeRules": true,
- "getLookups": true,
- "getMergedParameters": true,
- "getMergedCompositeParameters": true
}{- "rules": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
], - "compositeRules": [
- {
- "code": "string",
- "groupCode": "string",
- "name": "string",
- "isActive": true,
- "createDate": "2026-03-25T10:13:57Z",
- "dependentRules": [
- "string"
], - "expression": "string"
}
], - "referenceValues": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}
], - "parametersSchema": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}, - "compositeParametersSchema": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}, - "lookups": [
- {
- "listKey": "string",
- "listItems": [
- {
- "id": 0,
- "uid": "string",
- "label": "string",
- "key": "string",
- "customAttributes": "string"
}
]
}
], - "mergedParametersSchema": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}, - "mergedCompositeParametersSchema": {
- "code": "string",
- "name": "string",
- "groupCode": "string",
- "description": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "schema": null,
- "jsonSchema": "string"
}, - "groupCode": "string"
}Retrieve all available documents data that is being requested
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Defines data that should be returned
| getCategories | boolean Indicates should categories be retrieved |
| getDocuments | boolean Indicates should documents be retrieved |
| getTemplates | boolean Indicates should templates be retrieved |
| getTypes | boolean Indicates should types be retrieved |
| isActive | boolean Nullable Represents search criteria by IsActive property Relevant for categories retrieval, indirectly for documents retrieval |
| documentTypeId | integer <int32> Nullable Represents search criteria by DocumentTypeId property Relevant for categories retrieval, indirectly for documents retrieval |
| documentMetadataName | string Nullable Represent search criteria by DocumentMetadataName property Relevant for documents retrieval |
| language | string Nullable Represent search criteria by Language property Relevant for categories retrieval, indirectly for documents retrieval |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "getCategories": true,
- "getDocuments": true,
- "getTemplates": true,
- "getTypes": true,
- "isActive": true,
- "documentTypeId": 0,
- "documentMetadataName": "string",
- "language": "string"
}{- "categories": [
- {
- "id": 0,
- "name": "string",
- "dmsDocumentTypeId": 0,
- "parentId": 0,
- "isActive": true
}
], - "documents": [
- {
- "id": 0,
- "filename": "string",
- "digitalSignature": "string",
- "contractId": "string",
- "customAttributes": "string",
- "externalId": "string",
- "dmsDocumentMetadataId": 0,
- "isActive": true,
- "extension": "string",
- "mimeType": "string",
- "languageTwoLetterIsoCode": "string"
}
], - "templates": [
- {
- "uId": "string",
- "key": "string",
- "name": "string",
- "title": "string",
- "category": 0,
- "types": [
- 0
]
}
], - "types": [
- {
- "id": 0,
- "name": "string"
}
]
}Retrieve all available
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| getTypes | boolean Indicates should types be retrieved |
| getTypeChannels | boolean Inidicates should type channels be retrieved |
| typeKeyPrefix | string Nullable Represent search criteria for type key prefix |
| isActive | boolean Nullable Represent search criteria for IsActive property |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "getTypes": true,
- "getTypeChannels": true,
- "typeKeyPrefix": "string",
- "isActive": true
}{- "types": [
- {
- "id": 0,
- "key": "string",
- "name": "string",
- "isActive": true,
- "channels": [
- {
- "channelKey": "Realtime",
- "recipientTypeKey": "Initiator"
}
]
}
]
}Gets all the products.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Internal Server Error
{- "products": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "status": "Unknown",
- "insuranceHolderType": "Person",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}
]
}Create new product definition
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| name | string Nullable |
| description | string Nullable |
| type | string Nullable |
| lineOfBusiness | string Nullable |
| insuranceCarrier | string Nullable |
| offerIdentifierFormat | string Nullable |
| policyIdentifierFormat | string Nullable |
| contractIdentifierFormat | string Nullable |
| insuranceHolderType | string (InsuranceHolderType) Enum: "Person" "LegalEntity" |
| createdBy | integer <int32> |
| businessStateMachine | object (ProductBusinessStateMachine) |
| policyDuration | object (PolicyDuration) |
| documents | Array of objects (Api.Products.Definition.Outputs.Documents.Document) Nullable |
| notifications | Array of objects (Notification) Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "insuranceHolderType": "Person",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}{- "code": "string"
}| code required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "productDefinition": {
- "code": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "status": "Unknown",
- "insuranceHolderType": "Person",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}
}Update product details.
| code required | string <uuid> Product code |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Patch product definition request
| code | string <uuid> |
| name | string Nullable |
| description | string Nullable |
| type | string Nullable |
| lineOfBusiness | string Nullable |
| insuranceCarrier | string Nullable |
| offerIdentifierFormat | string Nullable |
| policyIdentifierFormat | string Nullable |
| contractIdentifierFormat | string Nullable |
| status | string (ProductDefinitionStatus) Enum: "Unknown" "Draft" "Approved" "Rejected" "Obsolete" |
| insuranceHolderType | string (InsuranceHolderType) Enum: "Person" "LegalEntity" |
| createdBy | integer <int32> |
| businessStateMachine | object (ProductBusinessStateMachine) |
| policyDuration | object (PolicyDuration) |
| documents | Array of objects (Api.Products.Definition.Outputs.Documents.Document) Nullable |
| notifications | Array of objects (Notification) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "status": "Unknown",
- "insuranceHolderType": "Person",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| code required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "string",
- "productDefinitionCode": "string",
- "productDefinition": {
- "code": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "status": "Unknown",
- "insuranceHolderType": "Person",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}, - "version": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "status": "Unknown",
- "statusChangeDate": "2026-03-25T10:13:57Z",
- "statusChangedBy": 0,
- "riskParametersSchema": {
- "schema": null,
- "isRequired": true
}, - "pricingOutputSchema": {
- "schema": null,
- "isRequired": true
}, - "backOfficeDataSchema": {
- "schema": null,
- "isRequired": true
}, - "systemDataSchema": {
- "schema": null,
- "isRequired": true
}, - "rules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "uwRules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "referenceValues": [
- {
- "code": "string",
- "tags": [
- "string"
], - "overriddenValue": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}, - "persistanceRules": [
- {
- "actor": "Unknown",
- "fromSubStatusId": 0,
- "toSubStatusId": 0
}
]
}
], - "documents": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
], - "notifications": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
]
}| productCode required | string <uuid> |
| productVersion required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "string",
- "productDefinitionCode": "string",
- "productDefinition": {
- "code": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "status": "Unknown",
- "insuranceHolderType": "Person",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}, - "version": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "status": "Unknown",
- "statusChangeDate": "2026-03-25T10:13:57Z",
- "statusChangedBy": 0,
- "riskParametersSchema": {
- "schema": null,
- "isRequired": true
}, - "pricingOutputSchema": {
- "schema": null,
- "isRequired": true
}, - "backOfficeDataSchema": {
- "schema": null,
- "isRequired": true
}, - "systemDataSchema": {
- "schema": null,
- "isRequired": true
}, - "rules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "uwRules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "referenceValues": [
- {
- "code": "string",
- "tags": [
- "string"
], - "overriddenValue": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}, - "persistanceRules": [
- {
- "actor": "Unknown",
- "fromSubStatusId": 0,
- "toSubStatusId": 0
}
]
}
], - "documents": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
], - "notifications": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
]
}| code required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "string",
- "productDefinitionCode": "string",
- "productDefinition": {
- "code": "string",
- "name": "string",
- "description": "string",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "status": "Unknown",
- "insuranceHolderType": "Person",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "businessStateMachine": {
- "description": "string",
- "businessStates": [
- {
- "mainStatus": "Unknown",
- "subStatusId": 0,
- "name": "string",
- "description": "string"
}
], - "businessStateTransitions": [
- {
- "fromSubStatusId": 0,
- "toSubStatusId": 0,
- "shouldGenerateOfferId": true,
- "shouldGeneratePolicyId": true,
- "shouldGenerateContractId": true,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}, - "policyDuration": {
- "type": "Fixed",
- "policyPeriod": {
- "years": 0,
- "months": 0,
- "days": 0
}
}, - "documents": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "categoryId": 0,
- "documentIdentifier": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
]
}
]
}
], - "notifications": [
- {
- "name": "string",
- "description": "string",
- "type": 0,
- "notificationTemplateKey": "string",
- "uniqueIdentifier": "string",
- "metaData": [
- {
- "key": "string",
- "value": "string"
}
], - "transitions": [
- {
- "fromSubStatus": 0,
- "toSubStatus": 0,
- "rules": [
- {
- "actor": "Unknown",
- "ruleCode": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "recipients": [
- {
- "type": 0,
- "customRecipient": "string"
}
]
}
]
}
]
}, - "version": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "createdBy": 0,
- "status": "Unknown",
- "statusChangeDate": "2026-03-25T10:13:57Z",
- "statusChangedBy": 0,
- "riskParametersSchema": {
- "schema": null,
- "isRequired": true
}, - "pricingOutputSchema": {
- "schema": null,
- "isRequired": true
}, - "backOfficeDataSchema": {
- "schema": null,
- "isRequired": true
}, - "systemDataSchema": {
- "schema": null,
- "isRequired": true
}, - "rules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "uwRules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "referenceValues": [
- {
- "code": "string",
- "tags": [
- "string"
], - "overriddenValue": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}, - "persistanceRules": [
- {
- "actor": "Unknown",
- "fromSubStatusId": 0,
- "toSubStatusId": 0
}
]
}
], - "documents": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
], - "notifications": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
]
}| code required | string <uuid> |
| getParameters required | boolean |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| code required | string <uuid> |
| versionCode required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| status | string (ProductDefinitionStatus) Enum: "Unknown" "Draft" "Approved" "Rejected" "Obsolete" |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "status": "Unknown"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Get all products based on search criteria.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| page | integer <int32> |
| pageSize | integer <int32> |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "page": 0,
- "pageSize": 0
}{- "results": [
- {
- "name": "string",
- "code": "string",
- "versionCode": "string",
- "description": "string",
- "status": "Unknown",
- "versionStatus": "Unknown",
- "type": "string",
- "lineOfBusiness": "string",
- "insuranceCarrier": "string",
- "offerIdentifierFormat": "string",
- "policyIdentifierFormat": "string",
- "contractIdentifierFormat": "string",
- "insuranceHolderType": "Person",
- "versionPublishDate": "2026-03-25T10:13:57Z"
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}Update product details.
| code required | string <uuid> Product code |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Product version request
| code | string <uuid> |
| version | string Nullable Formed as x.y.z x -> schema changes y -> rules/reference values changes z -> Documents and notification changes |
| createdBy | integer <int32> |
| statusChangeDate | string <date-time> Nullable |
| statusChangedBy | integer <int32> Nullable |
| riskParametersSchema | object (DataSchemaParameter) |
| pricingOutputSchema | object (DataSchemaParameter) |
| backOfficeDataSchema | object (DataSchemaParameter) |
| systemDataSchema | object (DataSchemaParameter) |
| rules | Array of objects (ProductVersionRule) Nullable |
| uwRules | Array of objects (ProductVersionRule) Nullable |
| referenceValues | Array of objects (ProductVersionReferenceValue) Nullable |
| documents | Array of objects (ProductVersionDocument) Nullable |
| notifications | Array of objects (ProductVersionNotification) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "code": "string",
- "version": "string",
- "createdBy": 0,
- "statusChangeDate": "2026-03-25T10:13:57Z",
- "statusChangedBy": 0,
- "riskParametersSchema": {
- "schema": null,
- "isRequired": true
}, - "pricingOutputSchema": {
- "schema": null,
- "isRequired": true
}, - "backOfficeDataSchema": {
- "schema": null,
- "isRequired": true
}, - "systemDataSchema": {
- "schema": null,
- "isRequired": true
}, - "rules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "uwRules": [
- {
- "code": "string",
- "tags": [
- "string"
], - "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
}
], - "referenceValues": [
- {
- "code": "string",
- "tags": [
- "string"
], - "overriddenValue": "string",
- "expression": {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}, - "persistanceRules": [
- {
- "actor": "Unknown",
- "fromSubStatusId": 0,
- "toSubStatusId": 0
}
]
}
], - "documents": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
], - "notifications": [
- {
- "uniqueCode": "string",
- "templateIdentifier": "string"
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| schema required | string non-empty |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "schema": "string"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| schema required | any |
| expressions required | Array of objects (RuleModel) |
| referenceValues | Array of objects (ReferenceValue) Nullable |
| sampleRequest | string Nullable |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "schema": null,
- "expressions": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "expression": "string",
- "isActive": true,
- "isCompositeDependent": true,
- "compositeCode": "string",
- "createDate": "2026-03-25T10:13:57Z",
- "parameters": [
- "string"
], - "referenceValues": [
- "string"
], - "groupCode": "string",
- "tags": [
- "string"
], - "positiveTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
], - "negativeTestCases": [
- {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
]
}
], - "referenceValues": [
- {
- "code": "string",
- "name": "string",
- "description": "string",
- "dataType": "Unknown",
- "valueKind": "Unknown",
- "isCollection": true,
- "interimVariables": {
- "property1": "string",
- "property2": "string"
}, - "value": "string",
- "dependencies": [
- "string"
], - "createDate": "2026-03-25T10:13:57Z",
- "testCases": [
- {
- "inputData": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "expectedResult": "string"
}
], - "parameterCompositeCode": "string",
- "tags": [
- "string"
], - "groupCode": "string"
}
], - "sampleRequest": "string"
}{- "property1": "string",
- "property2": "string"
}| productCode required | string <uuid> |
| productVersion required | string <uuid> |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| property name* | object (JsonNode) |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}{- "modelValidationErrors": [
- {
- "path": "string",
- "errorCode": "string"
}
], - "ruleError": "string",
- "isModelInvalid": true,
- "areRulesInvalid": true
}Retrieve all product versions filtered by parameters
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| page | integer <int32> |
| pageSize | integer <int32> |
| productDefinitionCode | string <uuid> |
| status | string (ProductDefinitionStatus) Enum: "Unknown" "Draft" "Approved" "Rejected" "Obsolete" |
OK
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Internal Server Error
{- "page": 0,
- "pageSize": 0,
- "productDefinitionCode": "string",
- "status": "Unknown"
}{- "results": [
- {
- "code": "string",
- "status": "Unknown",
- "version": "string",
- "createdBy": 0,
- "createDate": "2026-03-25T10:13:57Z",
- "statusChangedBy": 0,
- "statusChangeDate": "2026-03-25T10:13:57Z"
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}