openapi: 3.2.0 info: title: Fenergo Nebula Product Policy Query Product Requirements In… description: Product Policy Query API is part of FenX eco-system to query for Product Requirement Sets, Requirements, Data Groups and Data Group Fields Instances. All the operations require valid access token obtained from Identity service. version: '1.0' servers: - url: /productpolicyquery security: - Bearer: [] tags: - name: ProductRequirementsInScope paths: /api/product-requirements-in-scope/evaluate: post: tags: - ProductRequirementsInScope summary: Evaluate Product Requirements in scope description: 'Returns nonconditional and evaluated conditional Product Requirements that are in scope for a given search criteria and entity parameters. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: EvaluateProductRequirementsInScope parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Evaluate Product Requirements in scope request with a set of criteria to search Product Requirements and evaluate conditions content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementsInScopeRequestDtoServiceRequest' responses: '200': description: Success. List of Product Requirements is returned content: application/json: schema: $ref: '#/components/schemas/RequirementListServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product-requirements-in-scope/evaluate-all-requirements: post: tags: - ProductRequirementsInScope summary: Evaluate All Product Requirements in scope description: 'Returns all Product Requirements that are in scope for a given search criteria and entity parameters. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: EvaluateAllProductRequirements parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Evaluate Product Requirements in scope request with a set of criteria to search Product Requirements and evaluate conditions content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllProductRequirementsInScopeRequestDtoServiceRequest' responses: '200': description: Success. List of Product Requirements is returned content: application/json: schema: $ref: '#/components/schemas/EvaluatedAllProductRequirementsResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product-requirements-in-scope/search: post: tags: - ProductRequirementsInScope summary: Search Product Requirements description: 'Returns Product Requirements that are in scope for a given search criteria. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: SearchProductRequirements parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Product Requirements in scope request with a set of criteria to search content: application/json: schema: allOf: - $ref: '#/components/schemas/SearchProductRequirementsDtoServiceRequest' responses: '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '200': description: Success. List of Product Requirements is returned content: application/json: schema: $ref: '#/components/schemas/ProductRequirementDtoListServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product-requirements-in-scope: post: tags: - ProductRequirementsInScope summary: Get product requirements in scope description: 'Returns deduplicated Product Requirements that are in scope for a given search criteria. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: GetProductRequirementsInScope parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Product Requirements in scope request with a set of criteria to search content: application/json: schema: allOf: - $ref: '#/components/schemas/ProductRequirementsInScopeRequestDtoServiceRequest' responses: '200': description: Success. List of Product Requirements is returned content: application/json: schema: $ref: '#/components/schemas/ProductRequirementDtoListServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT /api/product-requirements-in-scope/evaluation-definitions: post: tags: - ProductRequirementsInScope summary: Get evaluation definitions description: 'Returns the versioned requirement sets matching the supplied pinned version IDs, plus the active version of any set that has activation conditions. Requirements are optionally filtered by type. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: GetEvaluationDefinitions parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Pinned jurisdictions and optional requirement type filter content: application/json: schema: allOf: - $ref: '#/components/schemas/GetEvaluationDefinitionsRequestDtoServiceRequest' responses: '200': description: Success. List of evaluation definition sets is returned content: application/json: schema: $ref: '#/components/schemas/EvaluationDefinitionSetDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT components: schemas: CollectionMinimumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2' additionalProperties: false ValueLimitRuleDtoConditionalValueDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' priority: type: integer format: int32 additionalProperties: false EntityAssociationDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true associationType: type: - string - 'null' ownershipPercentage: type: - number - 'null' format: double associationToClient: type: - string - 'null' properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ExternalProviderRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' providerId: type: string format: uuid additionalProperties: false EvaluateAllProductRequirementsInScopeRequestDto: type: object properties: requirementTypes: type: - array - 'null' items: type: string description: List of requirement types [Data, Document, OwnershipAndControl] jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the requirement in specific version targetEntity: type: - string - 'null' description: Target entity example: Client entityType: type: - string - 'null' description: Type of entity example: Company categories: type: - array - 'null' items: type: string description: List of requirement category e.g. ["Basic Details", "Enrich Details"] properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Entity data properties used for condition evaluation dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation journeyId: type: - string - 'null' format: uuid productId: type: - string - 'null' format: uuid isReadOnly: type: boolean preserveCategoryDuplicates: type: boolean cutOffDate: type: - string - 'null' format: date-time additionalProperties: false DateLimitRangeDto: type: object properties: type: type: - string - 'null' relativeTo: type: - string - 'null' source: type: - string - 'null' field: type: - string - 'null' offset: type: - string - 'null' periodType: type: - string - 'null' offsetPeriod: type: - string - 'null' additionalProperties: false EvaluatedCustomRequirementDto: type: object properties: propertyName: type: - string - 'null' description: Property name of custom data group requirement example: product dataGroupId: type: string description: The UiD of the data group format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f dataGroupVersionNumber: type: integer description: The version number of the data group format: int32 example: 1 dataGroupName: type: - string - 'null' description: Data group name example: Products name: type: - string - 'null' description: Requirement name example: Product description: type: - string - 'null' description: Requirement description example: This is the product object category: type: - string - 'null' description: Requirement business category example: Basic Details order: type: - number - 'null' description: Order format: double example: 1 isConditional: type: boolean description: Is requirement conditional example: false singleFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataFieldDto' description: Single custom data group fields customNestedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedCustomRequirementDto' description: Nested custom data group fields additionalProperties: false SpecialCharactersRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2' additionalProperties: false DateLimitRuleDto4: type: object properties: errorMessage: type: - string - 'null' minDate: type: - string - 'null' format: date-time maxDate: type: - string - 'null' format: date-time rangeFrom: allOf: - $ref: '#/components/schemas/DateLimitRangeDto' rangeTo: allOf: - $ref: '#/components/schemas/DateLimitRangeDto' additionalProperties: false ValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' regex: allOf: - $ref: '#/components/schemas/RegexRuleDto' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow todays date additionalProperties: false description: Request DTO representing validation data metadata Condition: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinition' additionalProperties: false EntityDataMetadataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: type: - string - 'null' additionalProperties: false ManualCreditScreeningDto: type: object properties: taskDataKey: type: - string - 'null' taskId: type: string format: uuid entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false RelatedPartyDto: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' metadata: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ReviewAndApprovalDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' approvalOutcome: type: - string - 'null' approvalReason: type: - string - 'null' taskId: type: - string - 'null' taskDataKey: type: - string - 'null' additionalProperties: false BasicRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' additionalProperties: false ProductRequirementsInScopeRequestDto: type: object properties: type: type: - string - 'null' description: Type of product requirement example: Data name: type: - string - 'null' description: Exact name of the product requirement example: Fenergo Comprehensive Standard Product Requirements category: type: - array - 'null' items: type: string description: List of product requirement category e.g. ["Basic Details", "Enrich Details"] jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the product requirement in specific version. Null versionId will get the latest. isMandatory: type: - boolean - 'null' description: Mandatory flag of the product requirement example: true entityType: type: - string - 'null' description: Type of entity example: Company isMaterialData: type: - boolean - 'null' description: Materiality flag of the product requirement example: true isSensitiveData: type: - boolean - 'null' description: Sensitive data flag of the product requirement example: true dataField: allOf: - $ref: '#/components/schemas/DataFieldDto' description: Data field definition isIndexable: type: - boolean - 'null' description: Requirement is data indexed for search flag example: true includeConditions: type: boolean description: 'Include conditions flag. If true, include the Requirements containing conditions. If false, only the Requirements without conditions will be returned. false' targetEntity: type: - string - 'null' description: Target entity example: Client disableFilteringForConditionalValues: type: boolean description: 'Filter product requirements containing conditional values only by basic properties: Target entity and Entity type' example: true enableBasicDataRequirementsFiltering: type: boolean description: 'Filter data requirements only by basic properties: Target entity and Entity type' disableDeduplication: type: boolean description: Disable Requirements deduplication based on data key example: true additionalProperties: false description: Request DTO representing product requirements search filter SlimDataFieldDto: type: object properties: propertyName: type: - string - 'null' propertyType: type: - string - 'null' propertyTypeId: type: - string - 'null' format: uuid linkChildFieldPropertyName: type: - string - 'null' linkedParentFieldPropertyName: type: - string - 'null' externalSearchApiProviderId: type: - string - 'null' format: uuid formulaSchema: allOf: - $ref: '#/components/schemas/FormulaSchemaDto' dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto' additionalProperties: false ConditionDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' additionalProperties: false ChangedFieldsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: - array - 'null' items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false RegexRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto' additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false OwnershipValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Mandatory requirement partyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: What is the minimum number of relationships that need to be added in order for this requirement to be fulfilled? addAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Is the unwrapping requirement non-calculable? idvIsMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Mandatory ID&V idvPartyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: What is the minimum number of relationships that need to be ID&Vd in order for this requirement to be fulfilled? idvAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Do all entities that meet the criteria of this requirement need to be ID&Vd? additionalProperties: false ValueField: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false EvaluateAllProductRequirementsInScopeRequestDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateAllProductRequirementsInScopeRequestDto' additionalProperties: false RequirementListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/Requirement' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false RelatedAssetDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false EvaluationDefinitionSetDto: type: object properties: versionId: type: string format: uuid jurisdiction: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' requirements: type: - array - 'null' items: $ref: '#/components/schemas/SlimProductRequirementDto' additionalProperties: false ValueLimitRuleDto2: type: object properties: errorMessage: type: - string - 'null' minValue: type: - integer - 'null' format: int32 maxValue: type: - integer - 'null' format: int32 additionalProperties: false ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' valueField: allOf: - $ref: '#/components/schemas/ValueField' additionalProperties: false RegexRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false EvaluatedAllProductRequirementsResponseDto: type: object properties: evaluatedSingleDataRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedSingleDataRequirementDto' description: Evaluated single data requirements evaluatedDataGroupRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupRequirementDto' description: Evaluated data group requirements evaluatedCustomRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedCustomRequirementDto' description: Evaluated legacy custom data group requirements evaluatedDocumentRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDocumentRequirementDto' description: Evaluated document requirements evaluatedOwnershipAndControlRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedOwnershipAndControlRequirementDto' description: Evaluated ownership and control requirements additionalProperties: false EvaluatedSingleDataRequirementDto: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked parent field property name example: productCategory name: type: - string - 'null' description: Requirement name example: First Name description: type: - string - 'null' description: Requirement description example: This is the client first name hasEvaluatedDefaultValue: type: boolean description: Does this field has evaluated default value? defaultValue: type: - string - 'null' description: Default Value example: Not Available isReadOnly: type: boolean description: Is requirement readonly example: false category: type: - string - 'null' description: Requirement business category example: Basic Details validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to requirement/data group field isRequired: type: boolean description: Is the field value mandatory order: type: - number - 'null' description: Order format: double example: 1 hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false isConditional: type: boolean description: Is requirement conditional example: false isSensitiveData: type: boolean description: Requirement sensitive data flag example: true fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Field Access Layers hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw customActionProperties: type: - object - 'null' additionalProperties: type: - string - 'null' description: 'Properties which can be passed to a custom action function in the UI, provided as basic string key-value pairs to allow action functions to be created generically.' conditionalLimitError: type: - string - 'null' description: Conditional limit error externalSearchApiProviderId: type: - string - 'null' description: Provider Id for Search Field that will be used to fetch options for the field format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c shouldClearValue: type: boolean description: Indicates the field value should be cleared because its trigger condition is not met example: false jurisdiction: type: - string - 'null' description: Requirement jurisdiction example: Global isIndexable: type: boolean description: Requirement is indexed for search example: true additionalProperties: false BasicRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto' additionalProperties: false DateLimitRuleDtoConditionalValueDto2: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: allOf: - $ref: '#/components/schemas/DateLimitRuleDto4' priority: type: integer format: int32 additionalProperties: false DateTimePeriodFormulaSchemaDto: type: object properties: formulaSetId: type: string description: Formula set id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c versionNumber: type: - integer - 'null' description: Formula set version number format: int32 example: 1 formulaString: type: - string - 'null' description: Formula string will be used to perform calculation example: $1 + $2 dateTimePeriodFormulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto' description: Metadata argument in formula string additionalProperties: false CalculatedResultDto: type: object properties: result: type: - string - 'null' description: Calculation result error: type: - string - 'null' description: Calculation error additionalProperties: false CurrentFieldDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true currentField: type: - string - 'null' additionalProperties: false AutoCreditScreeningDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' additionalProperties: false SignificanceEngineDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false DateTimePeriodFormulaVariableDto: type: object properties: dataSource: type: - string - 'null' timePeriodKind: type: - string - 'null' value: type: - string - 'null' type: type: - string - 'null' timeZoneId: type: - string - 'null' additionalProperties: false RegexRuleDto2: type: object properties: errorMessage: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false JourneyLevelDataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false PropertyDto: required: - type type: object properties: type: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true discriminator: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true isValid: type: - boolean - 'null' additionalProperties: false discriminator: propertyName: type mapping: Collection: '#/components/schemas/CollectionPropertyDto' Custom: '#/components/schemas/CustomPropertyDto' Single: '#/components/schemas/SinglePropertyDto' AccessLayerDto: type: object properties: geographic: type: - array - 'null' items: type: string description: Collection of geographic access layers e.g. ["Global"] businessRelated: type: - array - 'null' items: type: string description: Collection of business related access layers e.g. ["Global"] additionalProperties: false description: DTO representing associated access layers OwnershipValidationRuleDto: type: object properties: id: type: string description: The UiD of the ownership validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 ownershipValidationData: allOf: - $ref: '#/components/schemas/OwnershipValidationDataDto' description: Ownership Validation Data - set of validation rules specific to ownership requirement additionalProperties: false AutoCreditAssessmentDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditAssessmentDto' additionalProperties: false ReferenceDto: type: object properties: type: type: - string - 'null' description: Reference type example: FATCA description: type: - string - 'null' description: Reference description example: Foreign Account Tax Compliance Act url: type: - string - 'null' description: Reference URL example: www.irs.gov additionalProperties: false description: Request DTO representing reference metadata DateLimitRuleDto2: type: object properties: active: type: boolean message: type: - string - 'null' minDate: type: - string - 'null' format: date-time maxDate: type: - string - 'null' format: date-time rangeFrom: allOf: - $ref: '#/components/schemas/DateLimitRangeDto' rangeTo: allOf: - $ref: '#/components/schemas/DateLimitRangeDto' additionalProperties: false SearchProductRequirementsDto: type: object properties: name: type: - string - 'null' description: Exact name of the product requirement example: Fenergo Comprehensive Standard Policy Requirements type: type: - string - 'null' description: Type of product requirement example: Data jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the product requirement in specific version. Null versionId will get the latest. category: type: - array - 'null' items: type: string description: List of product requirement category e.g. ["Basic Details", "Enrich Details"] entityType: type: - string - 'null' description: Type of entity example: Company isMandatory: type: - boolean - 'null' description: Mandatory flag of the product requirement example: true isSensitiveData: type: - boolean - 'null' description: Sensitive data flag of the product requirement example: true isMaterialData: type: - boolean - 'null' description: Materiality flag of the product requirement example: true isIndexable: type: - boolean - 'null' description: Requirement is data indexed for search flag example: true dataField: allOf: - $ref: '#/components/schemas/DataFieldDto' description: Data field definition targetEntity: type: - string - 'null' description: Target entity example: Client includeConditions: type: boolean description: 'Include conditions flag. If true, include the Requirements containing conditions. If false, only the Requirements without conditions will be returned. false' additionalProperties: false description: Request DTO representing product requirements search filter BasicRuleDto2: type: object properties: errorMessage: type: - string - 'null' additionalProperties: false CollectionItemDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' additionalProperties: false CollectionPropertyDto2: type: object properties: items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CollectionItemDto' collectionId: type: - string - 'null' format: uuid additionalProperties: false Requirement: required: - discriminator type: object properties: discriminator: type: - string - 'null' readOnly: true version: type: integer format: int32 isLocked: type: boolean rootVersionId: type: string format: uuid versionNumber: type: integer format: int32 id: type: string format: uuid tenant: type: - string - 'null' category: type: - string - 'null' description: type: - string - 'null' template: type: - string - 'null' entityType: type: - string - 'null' name: type: - string - 'null' isSensitiveData: type: boolean isMaterialData: type: boolean isCoreDefinition: type: boolean jurisdiction: type: - string - 'null' dataProtectionJurisdiction: type: - string - 'null' references: type: - array - 'null' items: $ref: '#/components/schemas/Reference' targetEntity: type: - string - 'null' classification: type: - string - 'null' type: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/Condition' tags: type: - array - 'null' items: type: string RequirementSetId: type: string format: uuid additionalProperties: false discriminator: propertyName: discriminator mapping: Data: '#/components/schemas/DataRequirement' Document: '#/components/schemas/DocumentRequirement' eSignature Document: '#/components/schemas/ESignatureDocumentRequirement' Ownership and Control: '#/components/schemas/OwnershipAndControlRequirement' DataGroup: '#/components/schemas/DataGroupField' EvaluatedDocumentRequirementDto: type: object properties: id: type: string description: Requirement Id format: uuid name: type: - string - 'null' description: Document name example: Driving Licence dataKey: type: - string - 'null' description: Document datakey example: drivingLicence description: type: - string - 'null' description: Document description example: Driving Licence document category: type: - string - 'null' description: Document business category example: Basic Details isRequired: type: boolean description: Is document mandatory isConditional: type: boolean description: Is document conditional example: false additionalProperties: false EvaluationDefinitionSetDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EvaluationDefinitionSetDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EmptyRuleDto: type: object additionalProperties: false MainEntityDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false BasicRuleDtoConditionalValueDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: allOf: - $ref: '#/components/schemas/BasicRuleDto2' priority: type: integer format: int32 additionalProperties: false VersionedJurisdictionDto: type: object properties: jurisdiction: type: - string - 'null' description: Jurisdiction of the requirement example: Global versionId: type: - string - 'null' description: Jurisdiction of the requirement format: uuid example: 894e1443-dd7a-4b9d-b253-430c2de80524 additionalProperties: false EvaluatedAllProductRequirementsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluatedAllProductRequirementsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ExternalProviderRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2' additionalProperties: false ValueLimitRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto' additionalProperties: false CustomPropertyDto2: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false SearchProductRequirementsDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/SearchProductRequirementsDto' description: Request DTO representing product requirements search filter additionalProperties: false CollectionMinimumCountRuleDto2: type: object properties: errorMessage: type: - string - 'null' requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMinimumCount: type: integer format: int32 additionalProperties: false ExternalDataAdapterDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false RelatedAssetsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssetDto' additionalProperties: false CurrentDataGroupItemDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false InvestmentAccountFundDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false SpecialCharactersRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false BasicRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' additionalProperties: false DataSourcesDto: type: object properties: entityDataMetadata: allOf: - $ref: '#/components/schemas/EntityDataMetadataDataSource' eventIngress: allOf: - $ref: '#/components/schemas/EventIngressDataSource' changedFields: allOf: - $ref: '#/components/schemas/ChangedFieldsDataSource' relatedClient: allOf: - $ref: '#/components/schemas/RelatedClientDataSource' relatedProducts: allOf: - $ref: '#/components/schemas/RelatedProductsDataSource' currentDataGroupItem: allOf: - $ref: '#/components/schemas/CurrentDataGroupItemDataSource' externalDataAdapter: allOf: - $ref: '#/components/schemas/ExternalDataAdapterDataSource' entityAssociation: allOf: - $ref: '#/components/schemas/EntityAssociationDataSource' manualCreditAssessment: allOf: - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource' reviewAndApproval: allOf: - $ref: '#/components/schemas/ReviewAndApprovalDataSource' autoCreditAssessment: allOf: - $ref: '#/components/schemas/AutoCreditAssessmentDataSource' manualCreditScreening: allOf: - $ref: '#/components/schemas/ManualCreditScreeningDataSource' collateral: allOf: - $ref: '#/components/schemas/CollateralDataSource' currentJourneys: allOf: - $ref: '#/components/schemas/CurrentJourneysDataSource' autoCreditScreening: allOf: - $ref: '#/components/schemas/AutoCreditScreeningDataSource' currentProduct: allOf: - $ref: '#/components/schemas/CurrentProductDataSource' relatedDeals: allOf: - $ref: '#/components/schemas/RelatedDealsDataSource' mainEntity: allOf: - $ref: '#/components/schemas/MainEntityDataSource' relatedAssets: allOf: - $ref: '#/components/schemas/RelatedAssetsDataSource' relatedAssociations: allOf: - $ref: '#/components/schemas/RelatedAssociationsDataSource' accountRelatedFunds: allOf: - $ref: '#/components/schemas/AccountRelatedFundsDataSource' investmentAccountFund: allOf: - $ref: '#/components/schemas/InvestmentAccountFundDataSource' journeyLevelData: allOf: - $ref: '#/components/schemas/JourneyLevelDataDataSource' relatedParties: allOf: - $ref: '#/components/schemas/RelatedPartiesDataSource' currentField: allOf: - $ref: '#/components/schemas/CurrentFieldDataSource' significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDataSource' alert: allOf: - $ref: '#/components/schemas/AlertDataSource' relatedInvestmentManager: allOf: - $ref: '#/components/schemas/RelatedInvestmentManagerDataSource' relatedUnderlyingPrincipalOwner: allOf: - $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource' alertAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDataSource' currentProductMetadata: allOf: - $ref: '#/components/schemas/CurrentProductMetadataDataSource' currentUser: allOf: - $ref: '#/components/schemas/CurrentUserDataSource' additionalProperties: false DataFieldDto: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked Parent field property name example: productCategory formulaSchema: allOf: - $ref: '#/components/schemas/FormulaSchemaDto' description: Formula schema dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto' description: Date formula schema customActionProperties: type: - object - 'null' additionalProperties: type: - string - 'null' description: 'Properties which can be passed to a custom action function in the UI, provided as basic string key-value pairs to allow action functions to be created generically.' externalSearchApiProviderId: type: - string - 'null' description: External search API provider id format: uuid additionalProperties: false description: Response DTO representing data field data AlertDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: - string - 'null' type: type: - string - 'null' attribute: type: - string - 'null' additionalProperties: false EvaluatedDataGroupItemDto: type: object properties: evaluatedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupFieldDto' description: Evaluated data group fields additionalProperties: false SlimDataValidationRulesDto: type: object properties: mandatory: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' regex: allOf: - $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto' readOnly: allOf: - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto' timeZoneId: type: - string - 'null' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2' conditionalLimit: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' additionalProperties: false description: 'Slimmed validation rules DTO for the evaluation-definitions endpoint. Only includes rules that the client-side evaluation engine reads. Rules that are inactive (isActive=false, no dynamicRules) are omitted via the mapper — properties are null and serialized away by JsonIgnore. ExternalProvider and ExternalDataGroupProvider are stripped entirely (not consumed by the frontend eval engine).' RelatedInvestmentManagerDataSource: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false CollectionMaximumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2' additionalProperties: false RelatedProductDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' lifecycleStatus: type: - string - 'null' relationshipTypes: type: - array - 'null' items: type: string additionalProperties: false AutoCreditScreeningDto: type: object properties: entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' providerInternalIdentifier: type: - string - 'null' additionalProperties: false GetEvaluationDefinitionsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/GetEvaluationDefinitionsRequestDto' additionalProperties: false RelatedAssociationsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssociationDto' additionalProperties: false Reference: type: object properties: type: type: - string - 'null' description: type: - string - 'null' url: type: - string - 'null' additionalProperties: false RelatedClientDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false DateLimitRuleDtoConditionalValidationRuleDto2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/DateLimitRuleDto4' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto2' additionalProperties: false CollectionMaximumCountRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMaximumCount: type: - integer - 'null' format: int32 additionalProperties: false CurrentUserDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: - array - 'null' items: type: string format: uuid isSystemUser: type: boolean additionalProperties: false CollateralDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false RegexRuleDtoConditionalValueDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: allOf: - $ref: '#/components/schemas/RegexRuleDto2' priority: type: integer format: int32 additionalProperties: false GetEvaluationDefinitionsRequestDto: type: object properties: jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' requirementTypes: type: - array - 'null' items: type: string additionalProperties: false RelatedDealsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDealDto' additionalProperties: false CurrentProductMetadataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true isAgency: type: - string - 'null' lifecycleStatus: type: - string - 'null' additionalProperties: false ValidationRuleDto: type: object properties: id: type: string description: The UiD of the validation rule format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f setId: type: string description: The UiD of the requirement set/data group format: uuid example: 012cfe3a-7bfa-41e7-8269-d49b3b38dff3 propertyId: type: string description: The UiD of the requirement/data group field format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 propertyTypeId: type: - string - 'null' description: The Guid containing the property type id format: uuid example: 450df9bf-b2d3-48cf-ab8d-481c69b74373 linkChildFieldPropertyName: type: - string - 'null' description: The string containing the property name child of this property, only has value when propertyType is set to "selectLink" example: country linkedParentFieldPropertyName: type: - string - 'null' description: The string containing the property name parent of this property, only has value when propertyType is set to "LinkedSelectV2" or "LinkedMultiSelectV2" example: country dataGroupId: type: - string - 'null' description: The UiD of the of data group - is set only when requirement/data group field propertyType is set to "dataGroup" format: uuid example: 8eb83ec6-1539-46a9-b0ba-c5138a09580c isDataGroup: type: boolean description: Flag indicating it is validation rules for data group field example: true propertyName: type: - string - 'null' description: Requirement/data group field property name example: firstName friendlyName: type: - string - 'null' description: Requirement/data group field friendly Name example: First Name validationType: type: - string - 'null' description: Validation type example: text validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to requirement/data group field additionalProperties: false description: Request DTO representing validation rule metadata SinglePropertyDto2: type: object properties: value: type: - string - 'null' valueId: type: - string - 'null' additionalProperties: false ProductRequirementDto: type: object properties: rootVersionId: type: string description: The UiD of the root requirement set version format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f versionNumber: type: integer description: Requirement set version number format: int32 example: 1 id: type: string description: The UiD of the requirement format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd tenant: type: - string - 'null' description: The UiD of the tenant example: c345f3e9-c9f7-40ac-9eaa-654c2d2de1d1 category: type: - string - 'null' description: Requirement business category example: Basic Details description: type: - string - 'null' description: Requirement description example: This is the client first name template: type: - string - 'null' description: Requirement template example: Product entityType: type: - string - 'null' description: Requirement entity type example: Individual name: type: - string - 'null' description: Requirement name example: First Name isSecondaryIdentifier: type: boolean description: Requirement Secondary Identifier flag example: true isSensitiveData: type: boolean description: Requirement sensitive data flag example: true isMaterialData: type: boolean description: Requirement material data flag example: true isCoreDefinition: type: boolean description: 'Requirement is defined as core and cannot be deleted or altered' example: false jurisdiction: type: - string - 'null' description: Requirement jurisdiction example: Global references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto' description: Requirement references list targetEntity: type: - string - 'null' description: Requirement target entity example: Client classification: type: - string - 'null' description: Requirement classification example: Customer Profiling type: type: - string - 'null' description: Requirement type example: Data conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Requirement conditions list RequirementSetId: type: string description: The UiD of the current requirement set version format: uuid example: c060f297-70a2-4d4c-9360-9b5b39060ff0 versionId: type: string description: The UiD of the current requirement set version format: uuid example: e060f297-70a2-4d4c-9360-9b5b39060ff0 dataField: allOf: - $ref: '#/components/schemas/DataFieldDto' description: Data Field order: type: - number - 'null' description: Order format: double example: 1 defaultValue: type: - string - 'null' description: Default Value example: Not Available defaultDateType: type: - string - 'null' description: Default Date Type e.g. Standard Default Value example: 'true' isReadOnly: type: boolean description: Is requirement readonly example: false isIndexable: type: boolean description: Is requirement indexable example: true isMandatoryIndexable: type: boolean description: Is requirement mandatory indexable example: true isMandatory: type: boolean description: Is requirement mandatory example: false documentDescription: type: - string - 'null' description: Document Description example: Driver License documentDataKey: type: - string - 'null' description: Document Data Key acceptableDocumentTypes: type: - array - 'null' items: type: string description: Acceptable document types for the e-signature document requirement documentAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Document Access Layers ownershipDataKey: type: - string - 'null' description: Ownership Data Key example: DataKey partyTypes: type: - array - 'null' items: type: string description: Party Types e.g. ["Director"] uboThreshold: type: - number - 'null' description: UBO Threshold format: double example: 0.6 relatedPartyEntityTypes: type: - array - 'null' items: type: string description: Types of Related Party Entity e.g. ["Individual"] directAssociationsOnly: type: boolean description: Is Only direct association example: false idvOn: type: boolean description: Is Idv On example: false idvName: type: - string - 'null' description: Idv Name example: IdentityRequirement idvTooltip: type: - string - 'null' description: Idv Tooltip example: Identity Requirement ownershipValidationRule: allOf: - $ref: '#/components/schemas/OwnershipValidationRuleDto' description: Ownership Validation Rule validationRule: allOf: - $ref: '#/components/schemas/ValidationRuleDto' description: Validation Rule validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Requirement validation rules V2 conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto' description: List of conditional values hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value tags: type: - array - 'null' items: type: string description: List of tags isTotalProductColumn: type: boolean description: Specifies is field is going to be displayed with a total summation example: true uiDecoration: type: - string - 'null' description: 'Determines how the requirement should be rendered null' dataProtectionJurisdiction: type: - string - 'null' description: Jurisdiction for data protection example: Global aggregateVersion: type: - integer - 'null' description: Requirement aggregate version format: int32 example: 1 fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Field Access Layers clearValueIfTriggerConditionNotMet: type: boolean description: When enabled, the field value is cleared if its trigger condition is not met example: true additionalProperties: false description: Request DTO representing requirement metadata FormulaSchemaDto: type: object properties: formulaSetId: type: string description: Formula set id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c versionNumber: type: - integer - 'null' description: Formula set version number format: int32 example: 1 formulaString: type: - string - 'null' description: Formula string will be used to perform calculation example: $1 + $2 formulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/FormulaVariableDto' description: Metadata argument in formula string additionalProperties: false EventIngressDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false EmptyRuleDtoConditionalValueDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: allOf: - $ref: '#/components/schemas/EmptyRuleDto' priority: type: integer format: int32 additionalProperties: false ChangedFieldDto: type: object properties: key: type: - string - 'null' additionalProperties: false EvaluatedDataGroupRequirementDto: type: object properties: propertyName: type: - string - 'null' description: Property name of data group requirement example: firstName dataGroupId: type: string description: The UiD of the data group format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f dataGroupVersionNumber: type: integer description: The version number of the data group format: int32 example: 1 dataGroupName: type: - string - 'null' description: Data group name example: Addresses name: type: - string - 'null' description: Requirement name example: Mailing addresses description: type: - string - 'null' description: Requirement description example: This is the client mailing addresses isReadOnly: type: boolean description: Is requirement readonly example: false category: type: - string - 'null' description: Requirement business category example: Basic Details validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to data group order: type: - number - 'null' description: Order format: double example: 1 primaryDataGroupField: type: - string - 'null' description: Property name of primary data group field example: addressType disableMultiselectPrimaryFieldOnAdd: type: boolean description: When this field toggle is enabled, users will not be able to add multiple entries to a Data Group at once columns: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupColumnDto' description: All data group columns evaluatedItems: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/EvaluatedDataGroupItemDto' description: Evaluated data group items example: itemId: {} isConditional: type: boolean description: Is requirement conditional example: false externalSearchApiProviderId: type: - string - 'null' description: Provider Id for Search Field that will be used to fetch options for the field format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c additionalProperties: false RelatedPartiesDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyDto' additionalProperties: false EvaluateProductRequirementsInScopeRequestDto: type: object properties: requirementTypes: type: - array - 'null' items: type: string description: List of requirement types [Data, Document, OwnershipAndControl] jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the requirement in specific version targetEntity: type: - string - 'null' description: Target entity example: Client entityType: type: - string - 'null' description: Type of entity example: Company categories: type: - array - 'null' items: type: string description: List of requirement category e.g. ["Basic Details", "Enrich Details"] properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Entity data properties used for condition evaluation dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AlertAssessmentDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: - array - 'null' items: $ref: '#/components/schemas/AlertAssessmentDto' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto' lastAssessmentOutcome: type: - string - 'null' additionalProperties: false ExternalProviderRuleDto2: type: object properties: providerId: type: string format: uuid additionalProperties: false ConditionalValueDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' description: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' value: type: - string - 'null' priority: type: integer format: int32 valueId: type: - string - 'null' additionalProperties: false PropertiesDto: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' collectionProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CollectionPropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false SpecialCharactersRuleDto2: type: object properties: errorMessage: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false ValueLimitRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' additionalProperties: false CurrentJourneysDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: - array - 'null' items: type: string additionalProperties: false ConditionDefinition: type: object properties: fieldName: type: - string - 'null' value: type: - array - 'null' items: type: string valueId: type: - array - 'null' items: type: string valueType: type: - string - 'null' dataSource: type: - string - 'null' operation: type: - string - 'null' logicalOperation: type: - string - 'null' operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinition' valueField: allOf: - $ref: '#/components/schemas/ValueField' isCondition: type: boolean readOnly: true additionalProperties: false SignificanceEngineDto: type: object properties: singleFields: type: - array - 'null' items: type: string collections: type: - object - 'null' additionalProperties: type: - object - 'null' additionalProperties: type: array items: type: string additionalProperties: false EmptyRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/EmptyRuleDto' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto' additionalProperties: false ProductRequirementDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProductRequirementDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CollectionMaximumCountRuleDto2: type: object properties: errorMessage: type: - string - 'null' requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMaximumCount: type: - integer - 'null' format: int32 additionalProperties: false RelatedUnderlyingPrincipalOwnerDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ProductRequirementsInScopeRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ProductRequirementsInScopeRequestDto' description: Request DTO representing product requirements search filter additionalProperties: false ManualCreditAssessmentV2DataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/CreditAssessmentDto' additionalProperties: false ValueLimitRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' minValue: type: - integer - 'null' format: int32 maxValue: type: - integer - 'null' format: int32 additionalProperties: false AlertAssessmentDto: type: object properties: category: type: - string - 'null' additionalProperties: false AccountRelatedFundDto: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ReviewAndApprovalDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: - array - 'null' items: $ref: '#/components/schemas/ReviewAndApprovalDto' additionalProperties: false CreditAssessmentDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' assessmentOutcome: type: - string - 'null' assessmentComment: type: - string - 'null' taskId: type: - string - 'null' taskDataKey: type: - string - 'null' additionalProperties: false CollateralDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: - array - 'null' items: $ref: '#/components/schemas/CollateralDto' additionalProperties: false EvaluatedOwnershipAndControlRequirementDto: type: object properties: id: type: string description: Requirement Id format: uuid name: type: - string - 'null' description: Ownership and control requirement name example: Add 1 Controlling Person dataKey: type: - string - 'null' description: Ownership and control requirement datakey example: addControllingPerson description: type: - string - 'null' description: Ownership and control requirement description example: Add 1 Controlling Person category: type: - string - 'null' description: Ownership and control requirement business category example: Related Party Basic Details isRequired: type: boolean description: Is Ownership and control requirement mandatory isConditional: type: boolean description: Is Ownership and control requirement conditional example: false partyTypes: type: - array - 'null' items: type: string description: Ownership and control requirement party types additionalProperties: false RelatedDealDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' additionalProperties: false RelatedAssociationDto: type: object properties: associationType: type: - string - 'null' ownershipPercentage: type: - number - 'null' format: double associationToClient: type: - string - 'null' properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AutoCreditAssessmentDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' assessmentOutcome: type: - string - 'null' providerInternalIdentifier: type: - string - 'null' additionalProperties: false RelatedProductsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: - array - 'null' items: $ref: '#/components/schemas/RelatedProductDto' additionalProperties: false AccountRelatedFundsDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: - array - 'null' items: $ref: '#/components/schemas/AccountRelatedFundDto' additionalProperties: false CurrentProductDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' lifecycleStatus: type: - string - 'null' additionalProperties: false CollectionMinimumCountRuleDto: type: object properties: active: type: boolean message: type: - string - 'null' requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMinimumCount: type: integer format: int32 additionalProperties: false ManualCreditScreeningDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' additionalProperties: false DataGroupColumnDto: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text name: type: - string - 'null' description: Data group field name example: Product Type description: type: - string - 'null' description: Data group field description example: This is the field description order: type: - number - 'null' description: Data group field order format: double example: 2 isConditional: type: boolean description: Is data group field conditional example: false additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false FilterConditionDto: type: object properties: fieldName: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' additionalProperties: false PropertyType: enum: - Single - Custom - Collection type: string EvaluatedDataFieldDto: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked parent field property name example: productCategory name: type: - string - 'null' description: Requirement name example: First Name description: type: - string - 'null' description: Requirement description example: This is the client first name hasEvaluatedDefaultValue: type: boolean description: Does this field has evaluated default value? defaultValue: type: - string - 'null' description: Default Value example: Not Available isReadOnly: type: boolean description: Is requirement readonly example: false category: type: - string - 'null' description: Requirement business category example: Basic Details validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to requirement/data group field isRequired: type: boolean description: Is the field value mandatory order: type: - number - 'null' description: Order format: double example: 1 hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false isConditional: type: boolean description: Is requirement conditional example: false isSensitiveData: type: boolean description: Requirement sensitive data flag example: true fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Field Access Layers hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw customActionProperties: type: - object - 'null' additionalProperties: type: - string - 'null' description: 'Properties which can be passed to a custom action function in the UI, provided as basic string key-value pairs to allow action functions to be created generically.' conditionalLimitError: type: - string - 'null' description: Conditional limit error externalSearchApiProviderId: type: - string - 'null' description: Provider Id for Search Field that will be used to fetch options for the field format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c shouldClearValue: type: boolean description: Indicates the field value should be cleared because its trigger condition is not met example: false additionalProperties: false FormulaVariableDto: type: object properties: dataSource: type: - string - 'null' propertyName: type: - string - 'null' filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto' additionalProperties: false EvaluatedDataGroupFieldDto: type: object properties: propertyName: type: - string - 'null' description: Property name example: firstName propertyType: type: - string - 'null' description: Property type example: text propertyTypeId: type: - string - 'null' description: Property type id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c linkChildFieldPropertyName: type: - string - 'null' description: Linked child field property name example: productCategory linkedParentFieldPropertyName: type: - string - 'null' description: Linked parent field property name example: productCategory name: type: - string - 'null' description: Requirement name example: First Name description: type: - string - 'null' description: Requirement description example: This is the client first name hasEvaluatedDefaultValue: type: boolean description: Does this field has evaluated default value? defaultValue: type: - string - 'null' description: Default Value example: Not Available isReadOnly: type: boolean description: Is requirement readonly example: false category: type: - string - 'null' description: Requirement business category example: Basic Details validationData: allOf: - $ref: '#/components/schemas/ValidationDataDto' description: Validation Data - set of validation rules specific to requirement/data group field isRequired: type: boolean description: Is the field value mandatory order: type: - number - 'null' description: Order format: double example: 1 hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false isConditional: type: boolean description: Is requirement conditional example: false isSensitiveData: type: boolean description: Requirement sensitive data flag example: true fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Field Access Layers hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw customActionProperties: type: - object - 'null' additionalProperties: type: - string - 'null' description: 'Properties which can be passed to a custom action function in the UI, provided as basic string key-value pairs to allow action functions to be created generically.' conditionalLimitError: type: - string - 'null' description: Conditional limit error externalSearchApiProviderId: type: - string - 'null' description: Provider Id for Search Field that will be used to fetch options for the field format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c shouldClearValue: type: boolean description: Indicates the field value should be cleared because its trigger condition is not met example: false additionalProperties: false EvaluateProductRequirementsInScopeRequestDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementsInScopeRequestDto' additionalProperties: false SlimProductRequirementDto: type: object properties: id: type: string format: uuid name: type: - string - 'null' type: type: - string - 'null' jurisdiction: type: - string - 'null' category: type: - string - 'null' entityType: type: - string - 'null' targetEntity: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' references: type: - array - 'null' items: {} order: type: - number - 'null' format: double isReadOnly: type: - boolean - 'null' isSensitiveData: type: - boolean - 'null' isSecondaryIdentifier: type: - boolean - 'null' clearValueIfTriggerConditionNotMet: type: - boolean - 'null' isMandatory: type: - boolean - 'null' defaultValue: type: - string - 'null' defaultDateType: type: - string - 'null' conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto' dataField: allOf: - $ref: '#/components/schemas/SlimDataFieldDto' validationRulesV2: allOf: - $ref: '#/components/schemas/SlimDataValidationRulesDto' description: 'Slimmed validation rules DTO for the evaluation-definitions endpoint. Only includes rules that the client-side evaluation engine reads. Rules that are inactive (isActive=false, no dynamicRules) are omitted via the mapper — properties are null and serialized away by JsonIgnore. ExternalProvider and ExternalDataGroupProvider are stripped entirely (not consumed by the frontend eval engine).' additionalProperties: false description: 'Slimmed requirement DTO for the evaluation-definitions endpoint. Contains only the fields the client-side evaluation engine needs. Reduces payload from ~265 KB to ~51 KB (81% reduction) for a typical product.' DataValidationRulesDto: type: object properties: mandatory: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' regex: allOf: - $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto' externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto' readOnly: allOf: - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto' conditionalLimit: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' timeZoneId: type: - string - 'null' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow todays date additionalProperties: false description: Request DTO representing validation data metadata securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header