openapi: 3.2.0 info: title: Fenergo Engine API version: '1.0' description: 'Operations tagged Engine across 6 of this provider''s published API definitions: fenergo-journeylogicengine-v1-0-openapi.json, fenergo-journeylogicengine-v2-0-openapi.json, fenergo-policylogicengine-v1-0-openapi.json, fenergo-policylogicengine-v2-0-openapi.json, fenergo-policylogicengine-v3-0-openapi.json, fenergo-productpolicylogicengine-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /journeylogicengine - url: /policylogicengine - url: /productpolicylogicengine security: - Bearer: [] tags: - name: Engine paths: /api/engine/evaluate-journey-schema: post: tags: - Engine summary: Evaluates logic condition to retrieve matching Journey Schema(s) description: 'Executes logic engine to retrieve all journey schemas that requests match with defined conditions. Returns the collection of matching journey schemas filtered by journey type if filter provided. Required permissions: Following permissions are required: JourneyCreate' operationId: EvaluateJourneySchema parameters: - name: journeyTypeFilter in: query description: 'Optional filter(s) to retrieve matched schemas only for specified journey type. If multiple filters specified (i.e. Client Onboarding and Client Offboarding) both journey types will be returned (if matched). If empty (no filters), all matched journey types will be returned.' schema: type: array items: type: string - 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateJourneySchemaRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated journey schemas is returned content: application/json: schema: $ref: '#/components/schemas/EvaluateJourneySchemaResponseDtoIEnumerableServiceResponse' '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 servers: - url: /journeylogicengine /api/v2/engine/evaluate-journey-schema: post: tags: - Engine summary: Evaluates logic condition to retrieve matching Journey Schema(s) description: 'Executes logic engine to retrieve all journey schemas that requests match with defined conditions. Returns the collection of matching journey schemas filtered by journey type if filter provided. Required permissions: Following permissions are required: JourneyCreate' operationId: EvaluateJourneySchemaV2 parameters: - name: journeyTypeFilter in: query description: 'Optional filter(s) to retrieve matched schemas only for specified journey type. If multiple filters specified (i.e. Client Onboarding and Client Offboarding) both journey types will be returned (if matched). If empty (no filters), all matched journey types will be returned.' schema: type: array items: type: string - 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateJourneySchemaRequestV2DtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated journey schemas is returned content: application/json: schema: $ref: '#/components/schemas/EvaluateJourneySchemaResponseDtoIEnumerableServiceResponse' '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 servers: - url: /journeylogicengine /api/engine/evaluate: post: tags: - Engine summary: Evaluate requirement description: 'Evaluates requirement logic conditions. Returns the collection of matching requirements. Required permissions: Following permissions are required: PolicySearch' operationId: Evaluate parameters: - name: jurisdictions in: query description: 'List of jurisdictions from which we want to return evaluated requirements. If not set Global will be returned' schema: type: array items: type: string - name: requirementTypes in: query description: 'Types of the requirements for each we want to return evaluated requirements. If is not set all requirements will be returned.' schema: type: array items: type: string - 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated requirements is returned content: text/plain: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' application/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' text/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/engine/evaluate-requirement-sets: post: tags: - Engine summary: Evaluate requirement set description: 'Evaluates requirement set logic conditions. Returns the collection of matching requirement sets. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateRequirementSets 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated requirement sets is returned content: text/plain: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/engine/evaluate-data-group-fields: post: tags: - Engine summary: Evaluate data group fields description: 'Evaluates data group field logic conditions. Returns the collection of matching data group fields. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateDataGroupFields 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated data group fields is returned content: text/plain: schema: $ref: '#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v2/engine/evaluate-requirements: post: tags: - Engine summary: Evaluate requirement description: 'Evaluates requirement logic conditions. Returns the collection of matching requirements. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateV2 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV2DtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV2DtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV2DtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated requirements is returned content: text/plain: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' application/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' text/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v2/engine/evaluate-requirement-sets: post: tags: - Engine summary: Evaluate requirement set description: 'Evaluates requirement set logic conditions. Returns the collection of matching requirement sets. Required permissions: Following permissions are required: PolicySearch' operationId: postApiV2EngineEvaluateRequirementSets 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated requirement sets is returned content: text/plain: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 x-operation-id-source: normalized x-operation-id-original: EvaluateRequirementSets servers: - url: /policylogicengine /api/v2/engine/evaluate-data-group-fields: post: tags: - Engine summary: Evaluate data group fields description: 'Evaluates data group field logic conditions. Returns the collection of matching data group fields. Required permissions: Following permissions are required: PolicySearch' operationId: postApiV2EngineEvaluateDataGroupFields 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated data group fields is returned content: text/plain: schema: $ref: '#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/DataGroupFieldDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 x-operation-id-source: normalized x-operation-id-original: EvaluateDataGroupFields servers: - url: /policylogicengine /api/v3/engine/evaluate-requirement-sets: post: tags: - Engine summary: Evaluate requirement set description: 'Evaluates requirement set logic conditions. Returns the collection of matching requirement sets. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateRequirementSetsV3 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: Service request with entity data properties required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestV2DtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestV2DtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestV2DtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated requirement sets is returned content: text/plain: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v3/engine/evaluate-requirements: post: tags: - Engine summary: Evaluate requirement description: 'Evaluates requirement logic conditions. Returns the collection of matching requirements. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateV3 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV3DtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV3DtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV3DtoServiceRequest' description: Service request data responses: '200': description: Success. The list of evaluated requirements is returned content: text/plain: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' application/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' text/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v3/engine/evaluate-requirements-in-scope: post: tags: - Engine summary: Evaluate requirements in scope description: 'Returns evaluated requirements that are in scope for a given parameters. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateRequirementsInScope 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 requirements in scope request with a set of criteria to filter requirements and evaluate conditions.' content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsInScopeV2RequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsInScopeV2RequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateRequirementsInScopeV2RequestDtoServiceRequest' description: Service request data responses: '200': description: Success. List of requirements is returned. content: text/plain: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' application/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' text/json: schema: $ref: '#/components/schemas/RequirementDtoListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v3/engine/evaluate-all-requirements: post: tags: - Engine summary: Evaluate all requirements description: 'Recommended way to get all evaluated requirements (conditional and not) for a given parameters. Works similar to /evaluate-requirements-in-scope but uses a different response schema enhanced with evaluated data group fields for each item. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateAllRequirements 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 all requirements request with a set of criteria to filter requirements and evaluate conditions.' content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. Response is returned. content: text/plain: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v3/engine/evaluate-all-requirements/read-only: post: tags: - Engine summary: Evaluate all requirements in read-only mode. description: 'Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateAllRequirementsReadOnly 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: content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. Response is returned. content: text/plain: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v3/engine/evaluate-all-requirements/read-only/normalized: post: tags: - Engine summary: Evaluate all requirements in read-only mode, returning a normalized response description: 'Behaves exactly like M:Fenergo.Nebula.Policy.Logic.Api.Controllers.v3.EngineController.EvaluateAllRequirementsReadOnly(Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest{Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.RequestDto.EvaluateAllRequirementsReadOnlyRequestDto}) but normalizes each data group''s per-item evaluated fields: every unique evaluated field is returned once in the data group''s `evaluatedFields` list, and each item carries only an ordered list of integer `evaluatedFieldRefs` (indices into that list). Consumers rehydrate an item by resolving its refs against the list in order. Intended for data groups with many near-identical items. Gated by the `EvaluateAllRequirementsDeduplicatedEnabled` feature flag — returns 404 when the flag is disabled for the tenant. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateAllRequirementsReadOnlyNormalized 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: content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. Response is returned. content: text/plain: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyNormalizedResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyNormalizedResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyNormalizedResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: The normalized endpoint is not enabled for the tenant. type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/v3/engine/evaluate-all-requirements/normalized: post: tags: - Engine summary: Evaluate all requirements, returning a normalized response description: 'Behaves exactly like M:Fenergo.Nebula.Policy.Logic.Api.Controllers.v3.EngineController.EvaluateAllRequirements(Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest{Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.RequestDto.EvaluateAllRequirementsRequestDto}) but normalizes each data group''s per-item evaluated fields: every unique evaluated field is returned once in the data group''s `evaluatedFields` list, and each item carries only an ordered list of integer `evaluatedFieldRefs` (indices into that list). Consumers rehydrate an item by resolving its refs against the list in order. Intended for data groups with many near-identical items. Gated by the `EvaluateAllRequirementsDeduplicatedEnabled` feature flag — returns 404 when the flag is disabled for the tenant. Required permissions: Following permissions are required: PolicySearch' operationId: EvaluateAllRequirementsNormalized 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: content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' description: Service request data text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' description: Service request data application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest' description: Service request data responses: '200': description: Success. Response is returned. content: text/plain: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsNormalizedResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsNormalizedResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluatedAllRequirementsNormalizedResponseDtoServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: The normalized endpoint is not enabled for the tenant. type: Error errorCode: Error Code '400': description: Bad request. The request has missing/invalid values. content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse' application/json: schema: $ref: '#/components/schemas/ServiceResponse' text/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 servers: - url: /policylogicengine /api/engine/evaluate-product-requirement-sets: post: tags: - Engine summary: Evaluate product requirement set description: 'Evaluates product requirement set logic conditions. Returns the collection of matching product requirement sets. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: EvaluateProductRequirementSets 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: Service request with entity data properties required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementSetsRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementSetsRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementSetsRequestDtoServiceRequest' responses: '200': description: Success. The list of evaluated product requirement sets is returned content: text/plain: schema: $ref: '#/components/schemas/EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicylogicengine /api/engine/evaluate-product-requirements: post: tags: - Engine summary: Evaluate product requirement description: 'Evaluates product requirement logic conditions for product domain. Returns the collection of matching product requirements. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: EvaluateProduct 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementsRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementsRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementsRequestDtoServiceRequest' responses: '200': description: Success. The list of evaluated product requirements is returned content: text/plain: schema: $ref: '#/components/schemas/ProductRequirementDtoListServiceResponse' application/json: schema: $ref: '#/components/schemas/ProductRequirementDtoListServiceResponse' text/json: schema: $ref: '#/components/schemas/ProductRequirementDtoListServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicylogicengine /api/engine/evaluate-products: post: tags: - Engine summary: Evaluate products description: 'Evaluates products using scoping rule. Returns the collection of product ids that matched the scoping rule. Required permissions: At least one of the following permissions is required: ProductConfigurationSearch, ProductConfigurationAccess' operationId: EvaluateProducts 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: Service request with key-value data required for evaluation content: application/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductsRequestDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductsRequestDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/EvaluateProductsRequestDtoServiceRequest' responses: '200': description: Success. The list of evaluated product ids is returned content: text/plain: schema: $ref: '#/components/schemas/EvaluateProductsResponseDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/EvaluateProductsResponseDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/EvaluateProductsResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: text/plain: schema: $ref: '#/components/schemas/ServiceResponse_2' application/json: schema: $ref: '#/components/schemas/ServiceResponse_2' text/json: schema: $ref: '#/components/schemas/ServiceResponse_2' '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_2' 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_2' 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_2' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /productpolicylogicengine components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EvaluateJourneySchemaResponseDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EvaluateJourneySchemaResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EvaluateJourneySchemaResponseDto: type: object properties: journeySchemaId: type: string description: The UiD of matched journey schema format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f journeySchemaVersion: type: integer description: The version number of matched journey schema format: int32 example: 1 name: type: - string - 'null' description: Name of matched journey schema example: Individual Client Onboarding identifier: type: - string - 'null' description: Short identifier of matched journey schema example: IND_ONB_1 journeyType: type: - string - 'null' description: Type of matched journey schema example: Client Onboarding channelType: allOf: - $ref: '#/components/schemas/ChannelTypeDto' description: Channel type of matched journey schema additionalProperties: false description: Response DTO representing parameters of matched journey schema ChannelTypeDto: enum: - Internal - External - InternalAndExternal type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response ObjectServiceResponse: type: object properties: data: description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EvaluateJourneySchemaRequestDtoServiceRequest: type: object properties: data: type: - object - 'null' additionalProperties: type: string description: Key-value pairs used to evaluate the condition example: entityType: Company additionalProperties: false description: Service request data StringServiceResponse: type: object properties: data: type: - string - 'null' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 InvestmentAccountFundDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties of the single investment account fund additionalProperties: false DataSourcesDto: type: object properties: entityDataMetadata: allOf: - $ref: '#/components/schemas/EntityDataMetadataDataSource' description: DataSource for EntityDraft information beside generic properties eventIngress: allOf: - $ref: '#/components/schemas/EventIngressDataSource' description: DataSource for EventIngress event details changedFields: allOf: - $ref: '#/components/schemas/ChangedFieldsDataSource' description: DataSource for detecting changed EntityDraft properties in comparasion with verified Entity relatedClient: allOf: - $ref: '#/components/schemas/RelatedClientDataSource' description: DataSource for new Related Client properties added in Association task relatedProducts: allOf: - $ref: '#/components/schemas/RelatedProductsDataSource' description: DataSource for new Related Product properties added in Manage Product task currentDataGroupItem: allOf: - $ref: '#/components/schemas/CurrentDataGroupItemDataSource' description: DataSource for single, current data group row item. Can be used only for Data Group field conditions. externalDataAdapter: allOf: - $ref: '#/components/schemas/ExternalDataAdapterDataSource' description: DataSource for External Data Adapter (Ongoing Monitoring) event details entityAssociation: allOf: - $ref: '#/components/schemas/EntityAssociationDataSource' description: DataSource for entity association details manualCreditAssessment: allOf: - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource' description: DataSource for manual credit assessment reviewAndApproval: allOf: - $ref: '#/components/schemas/ReviewAndApprovalDataSource' description: DataSource for review and approval autoCreditAssessment: allOf: - $ref: '#/components/schemas/AutoCreditAssessmentDataSource' description: DataSource for auto credit assessment manualCreditScreening: allOf: - $ref: '#/components/schemas/ManualCreditScreeningDataSource' collateral: allOf: - $ref: '#/components/schemas/CollateralDataSource' currentJourneys: allOf: - $ref: '#/components/schemas/CurrentJourneysDataSource' description: DataSource for entity current journeys autoCreditScreening: allOf: - $ref: '#/components/schemas/AutoCreditScreeningDataSource' description: DataSource for auto credit screening currentProduct: allOf: - $ref: '#/components/schemas/CurrentProductDataSource' description: DataSource for product scoping relatedDeals: allOf: - $ref: '#/components/schemas/RelatedDealsDataSource' description: DataSource for related deals mainEntity: allOf: - $ref: '#/components/schemas/MainEntityDataSource' description: DataSource for main entity properties used for condition evaluation relatedAssets: allOf: - $ref: '#/components/schemas/RelatedAssetsDataSource' description: DataSource for related assets relatedAssociations: allOf: - $ref: '#/components/schemas/RelatedAssociationsDataSource' description: DataSource for related associations accountRelatedFunds: allOf: - $ref: '#/components/schemas/AccountRelatedFundsDataSource' description: DataSource for account related funds investmentAccountFund: allOf: - $ref: '#/components/schemas/InvestmentAccountFundDataSource' description: DataSource for investment account fund investmentAccountRelatedFundShareClass: allOf: - $ref: '#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource' description: DataSource for investment account related fund share class investmentAccount: allOf: - $ref: '#/components/schemas/InvestmentAccountDataSource' description: DataSource for in-scope investment accounts, evaluated across all accounts on the entity journeyLevelData: allOf: - $ref: '#/components/schemas/JourneyLevelDataDataSource' description: DataSource for draft properties using journey level data requirements used for journey scoping relatedParties: allOf: - $ref: '#/components/schemas/RelatedPartiesDataSource' description: DataSource for related parties entity properties currentField: allOf: - $ref: '#/components/schemas/CurrentFieldDataSource' description: DataSource for condtional limit validation significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDataSource' description: DataSource for significance engine alert: allOf: - $ref: '#/components/schemas/AlertDataSource' description: DataSource for Transaction Monitoring Alert relatedFCRs: allOf: - $ref: '#/components/schemas/RelatedFCRsDataSource' description: DataSource for related FCRs in product domain relatedInvestmentManager: allOf: - $ref: '#/components/schemas/RelatedInvestmentManagerDataSource' description: Related Investment Manager data source for product domain relatedUnderlyingPrincipalOwner: allOf: - $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource' description: Data Source for Related UP Owners alertAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDataSource' description: DataSource for Transaction Monitoring Alert assessment outcomes currentProductMetadata: allOf: - $ref: '#/components/schemas/CurrentProductMetadataDataSource' description: DataSource for Product Metadata currentUser: allOf: - $ref: '#/components/schemas/CurrentUserDataSource' description: DataSource for current user relatedDocuments: allOf: - $ref: '#/components/schemas/RelatedDocumentsDataSource' description: DataSource for related documents screeningMateriality: allOf: - $ref: '#/components/schemas/ScreeningMaterialityDataSource' description: DataSource for Screening Materiality Assessment outcomes for the entity being evaluated (main entity or a specific related party). additionalProperties: false CurrentFieldDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true currentField: type: - string - 'null' additionalProperties: false EntityAssociationDataSource: required: - associationToClient - associationType type: object properties: dataSource: type: - string - 'null' readOnly: true associationType: minLength: 1 type: string ownershipPercentage: type: - number - 'null' format: double associationToClient: minLength: 1 type: string properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false CurrentJourneysDataSource: required: - inProgressJourneyTypes type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: array items: type: string 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 AutoCreditScreeningDataSource: required: - creditScreenings type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: array items: $ref: '#/components/schemas/AutoCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto' additionalProperties: false SignificanceEngineDataSource: required: - significanceEngine type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false AlertDataSource: required: - attribute - source - type type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: string type: type: string attribute: type: string additionalProperties: false RelatedInvestmentManagerDataSource: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false RelatedProductDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in product policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd lifecycleStatus: type: - string - 'null' description: System field used in backend for status of a product in lifecycle relationshipTypes: type: - array - 'null' items: type: string description: System field used in backend for product of a product relationship additionalProperties: false JourneyLevelDataDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false PropertyDto: 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 AutoCreditScreeningDto: required: - properties type: object properties: entityId: type: string description: Entity Id format: uuid creditScreeningOutcome: type: - string - 'null' description: The outcome recorded for a manual screening task. properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy for auto credit screening example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd providerInternalIdentifier: type: - string - 'null' description: Provider Internal Identifier additionalProperties: false AutoCreditAssessmentDataSource: required: - autoCreditAssessments type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: array items: $ref: '#/components/schemas/AutoCreditAssessmentDto' additionalProperties: false InvestmentAccountDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties of a single in-scope investment account additionalProperties: false RelatedAssociationsDataSource: required: - relatedAssociations type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: array items: $ref: '#/components/schemas/RelatedAssociationDto' additionalProperties: false EntityDataMetadataDataSource: required: - entityType type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: minLength: 1 type: string additionalProperties: false RelatedDocumentVersionedDto: type: object properties: documentKey: type: - string - 'null' documentType: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false ManualCreditScreeningDto: required: - properties type: object properties: taskDataKey: type: - string - 'null' description: Task Data Key taskId: type: string description: Task Id format: uuid entityId: type: string description: Entity Id format: uuid creditScreeningOutcome: type: - string - 'null' description: The outcome recorded for a manual screening task. properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy for manual credit screening example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedUnderlyingPrincipalOwnerDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ManualCreditAssessmentV2DataSource: required: - creditAssessments type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: array items: $ref: '#/components/schemas/CreditAssessmentDto' additionalProperties: false RelatedClientDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedPartyDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties setup in policy metadata: type: - object - 'null' additionalProperties: type: - string - 'null' description: The properties from the actual relationship additionalProperties: false ReviewAndApprovalDto: required: - approvalOutcome type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy for review and approval task example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd approvalOutcome: type: string description: The Approval Outcome of the task approvalReason: type: - string - 'null' description: The Reason of the approval decision. taskId: type: - string - 'null' description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key additionalProperties: false RelatedFCRsDataSource: required: - fcRs type: object properties: dataSource: type: - string - 'null' readOnly: true fcRs: type: array items: $ref: '#/components/schemas/RelatedFCRDto' additionalProperties: false EvaluateJourneySchemaRequestV2Dto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Entity data properties for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation additionalProperties: false description: Request DTO representing entity data properties used to evaluate the condition of journey schema CurrentUserDataSource: required: - teamIds type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: array items: minLength: 1 type: string format: uuid isSystemUser: type: boolean additionalProperties: false InvestmentAccountDataSource: required: - investmentAccount type: object properties: dataSource: type: - string - 'null' readOnly: true investmentAccount: type: array items: $ref: '#/components/schemas/InvestmentAccountDto' additionalProperties: false ChangedFieldsDataSource: required: - changedFields type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: array items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false CollateralDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false AlertAssessmentDto: required: - category type: object properties: category: type: string additionalProperties: false AccountRelatedFundDto: required: - properties type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false ReviewAndApprovalDataSource: required: - reviewAndApprovals type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: array items: $ref: '#/components/schemas/ReviewAndApprovalDto' additionalProperties: false CreditAssessmentDto: required: - properties - taskId type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy for manual credit assessment example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd assessmentOutcome: type: - string - 'null' description: Assessment Outcome of this manual credit assessment assessmentComment: type: - string - 'null' description: Assessment Comment of this credit assessment taskId: type: string description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key 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 RelatedDocumentDto: required: - document type: object properties: document: allOf: - $ref: '#/components/schemas/RelatedDocumentVersionedDto' additionalProperties: false RelatedDealsDataSource: required: - relatedDeals type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: array items: $ref: '#/components/schemas/RelatedDealDto' additionalProperties: false RelatedDealDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false CollateralDataSource: required: - collaterals type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: array items: $ref: '#/components/schemas/CollateralDto' additionalProperties: false RelatedAssociationDto: required: - properties type: object properties: associationType: type: - string - 'null' description: Type of this association example: 'Employee of ' ownershipPercentage: type: - number - 'null' description: Ownership Percentage of this association format: double example: 0.5 associationToClient: type: - string - 'null' description: Association To Client example: Direct/Indirect properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false EvaluateJourneySchemaRequestV2DtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateJourneySchemaRequestV2Dto' description: The service request DTO additionalProperties: false description: Service request data RelatedAssetDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedProductsDataSource: required: - products type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: array items: $ref: '#/components/schemas/RelatedProductDto' additionalProperties: false AccountRelatedFundsDataSource: required: - accountRelatedFunds type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: array items: $ref: '#/components/schemas/AccountRelatedFundDto' additionalProperties: false MainEntityDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false CurrentProductDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in product policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd lifecycleStatus: type: - string - 'null' description: System field used in backend for status of a product in lifecycle additionalProperties: false AutoCreditAssessmentDto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Generic properties setup in policy for manual credit assessment example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd assessmentOutcome: type: - string - 'null' description: Assessment Outcome of this manual credit assessment providerInternalIdentifier: type: - string - 'null' description: Provider Internal Identifier additionalProperties: false CurrentProductMetadataDataSource: type: object properties: dataSource: type: - string - 'null' readOnly: true isAgency: type: - string - 'null' lifecycleStatus: type: - string - 'null' additionalProperties: false ManualCreditScreeningDataSource: required: - creditScreenings type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: array items: $ref: '#/components/schemas/ManualCreditScreeningDto' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto' additionalProperties: false RelatedFCRDto: required: - status type: object properties: status: type: string description: The status of the FCR. createdDate: type: string description: The date the FCR was created. format: date-time submittedDate: type: - string - 'null' description: The date the FCR was submitted. format: date-time additionalProperties: false SinglePropertyDto2: type: object properties: value: type: - string - 'null' valueId: type: - string - 'null' additionalProperties: false ScreeningMaterialityAssessmentDto: required: - adverseMediaJurisdictions - enforcementsJurisdictions - otherJurisdictions - pepJurisdictions - sanctionsJurisdictions type: object properties: mainEntity: type: boolean description: Whether this assessment is for the main entity (true) or a related party (false). materialityOutcome: type: - string - 'null' description: Overall materiality outcome of the screening assessment (e.g. "Material", "Non-Material"). pepMaterialityStatus: type: - string - 'null' description: PEP (Politically Exposed Person) materiality status. sanctionsMaterialityStatus: type: - string - 'null' description: Sanctions materiality status. adverseMediaMaterialityStatus: type: - string - 'null' description: Adverse media materiality status. enforcementsMaterialityStatus: type: - string - 'null' description: Enforcements materiality status. otherMaterialityStatus: type: - string - 'null' description: Other (non-categorised) materiality status. pepJurisdictions: type: array items: type: string description: PEP jurisdictions associated with this assessment. sanctionsJurisdictions: type: array items: type: string description: Sanctions jurisdictions associated with this assessment. adverseMediaJurisdictions: type: array items: type: string description: Adverse media jurisdictions associated with this assessment. enforcementsJurisdictions: type: array items: type: string description: Enforcements jurisdictions associated with this assessment. otherJurisdictions: type: array items: type: string description: Other jurisdictions associated with this assessment. sanctionsProceedDecision: type: - string - 'null' description: Sanctions ok-to-proceed decision text returned by Screening (e.g. "Ok to proceed", "Not to proceed"). additionalProperties: false AlertAssessmentDataSource: required: - assessments - lastAssessment type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: minItems: 1 type: array items: $ref: '#/components/schemas/AlertAssessmentDto' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto' lastAssessmentOutcome: type: - string - 'null' additionalProperties: false EventIngressDataSource: required: - eventSubtype - eventType type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string additionalProperties: false PropertyType: enum: - Single - Custom - Collection type: string CustomPropertyDto2: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SinglePropertyDto2' customProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/CustomPropertyDto2' additionalProperties: false RelatedDocumentsDataSource: required: - documents type: object properties: dataSource: type: - string - 'null' readOnly: true documents: type: array items: $ref: '#/components/schemas/RelatedDocumentDto' additionalProperties: false ChangedFieldDto: type: object properties: key: type: - string - 'null' additionalProperties: false RelatedPartiesDataSource: required: - relatedParties type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: array items: $ref: '#/components/schemas/RelatedPartyDto' additionalProperties: false ExternalDataAdapterDataSource: required: - eventSubtype - eventType type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: minLength: 1 type: string eventSubtype: minLength: 1 type: string additionalProperties: false InvestmentAccountRelatedFundShareClassDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties of the investment account related fund share class additionalProperties: false RelatedAssetsDataSource: required: - assets type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: array items: $ref: '#/components/schemas/RelatedAssetDto' additionalProperties: false CurrentDataGroupItemDataSource: required: - properties type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: object additionalProperties: type: - string - 'null' additionalProperties: false ScreeningMaterialityDataSource: required: - assessments type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: array items: $ref: '#/components/schemas/ScreeningMaterialityAssessmentDto' additionalProperties: false description: 'Data source for Screening Materiality Assessment outcomes. Contains a list of assessments — one per entity in the batch (main entity and related parties).' CollectionMinimumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2' description: Static validation rule always applied when active additionalProperties: false ValueLimitRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Request DTO representing value limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false EntityAssociationDataSource_2: 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' description: Generic properties additionalProperties: false ExternalProviderRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata SpecialCharactersRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2' description: Static validation rule always applied when active additionalProperties: false ValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDto' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto' description: Validation rule that allows to use external provider for validating all fields of a DataGroup as a collection additionalProperties: false description: Request DTO representing validation data metadata EntityDataMetadataDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: type: - string - 'null' additionalProperties: false ManualCreditScreeningDto_2: type: object properties: taskDataKey: type: - string - 'null' description: Task Data Key taskId: type: string description: Task Id format: uuid entityId: type: string description: Entity Id format: uuid creditScreeningOutcome: type: - string - 'null' description: The outcome recorded for a manual screening task. properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy for manual credit screening example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedPartyDto_2: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties setup in policy metadata: type: - object - 'null' additionalProperties: type: - string - 'null' description: The properties from the actual relationship additionalProperties: false ReviewAndApprovalDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy for review and approval task example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd approvalOutcome: type: - string - 'null' description: The Approval Outcome of the task approvalReason: type: - string - 'null' description: The Reason of the approval decision. taskId: type: - string - 'null' description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key additionalProperties: false BasicRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata ConditionDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto additionalProperties: false description: Represents condition root RegexRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false ChangedFieldsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: - array - 'null' items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false OwnershipValidationDataDto: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Request DTO representing basic validation rule metadata partyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Request DTO representing value limit rule metadata addAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Request DTO representing basic validation rule metadata idvIsMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Request DTO representing basic validation rule metadata idvPartyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Request DTO representing value limit rule metadata idvAllParties: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Request DTO representing basic validation rule metadata additionalProperties: false ValueField: type: object properties: dataSource: type: - string - 'null' description: Value of DataSource used to filter field values field: type: - string - 'null' description: Field value used to validate conditional value additionalProperties: false RelatedAssetDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false ValueLimitRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata DateLimitRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata ConditionDefinitionDto: type: object properties: fieldName: type: - string - 'null' description: Name of the field to evaluate example: EntityType value: type: - array - 'null' items: type: string description: List of values valueId: type: - array - 'null' items: type: string description: List of value ids valueType: type: - string - 'null' description: Type of the value example: text dataSource: type: - string - 'null' description: Data source from which field is retrieved. If empty then Entity Data properties will be used. example: entityDataMetadata operation: type: - string - 'null' description: Logical operation to be performed to match the values example: equal logicalOperation: type: - string - 'null' description: Logical operation to be performed on the operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto valueField: allOf: - $ref: '#/components/schemas/ValueField' description: Field value used for conditional limit validation additionalProperties: false description: Represents condition RegexRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata BasicRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false EvaluateRequirementSetsRequestDtoServiceRequest: type: object properties: data: type: - object - 'null' additionalProperties: type: string description: Request DTO representing key-value pairs used to evaluate the condition of requirement set example: entityType: Company additionalProperties: false description: Service request data DateTimePeriodFormulaSchemaDto: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: - string - 'null' dateTimePeriodFormulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/DateTimePeriodFormulaVariableDto' additionalProperties: false AutoCreditScreeningDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto_2' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto_2' additionalProperties: false SignificanceEngineDataSource_2: 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' description: Validation rule error message example: Validation error occurred isCaseSensitive: type: boolean description: Flag that indicate if regex is case sensitive example: false regexValue: type: - string - 'null' description: Regex expression example: ^[\\w-\\.]+@([\\w-]+\\.)+[\\w-]{2,4}$ additionalProperties: false description: Request DTO representing regex rule metadata AccessLayerDto: type: object properties: geographic: type: - array - 'null' items: type: string businessRelated: type: - array - 'null' items: type: string additionalProperties: false PropertyDto_2: 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' JourneyLevelDataDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false 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_2: type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditAssessmentDto_2' additionalProperties: false ReferenceDto: type: object properties: type: type: - string - 'null' description: type: - string - 'null' url: type: - string - 'null' additionalProperties: false EvaluateRequirementSetsResponseDto: type: object properties: requirementSetId: type: string description: The UiD of matched requirement set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Name of matched requirement set example: Fenergo Comprehensive Standard Policy Requirements jurisdiction: type: - string - 'null' description: Jurisdiction of matched requirement set example: Global additionalProperties: false description: Response DTO representing parameters of matched requirement set DateLimitRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred minDate: type: - string - 'null' description: Minimum date format: date-time example: '2020-01-01T14:48:00.000Z' maxDate: type: - string - 'null' description: Maximum date format: date-time example: '2021-01-01T14:48:00.000Z' additionalProperties: false description: Request DTO representing date limit rule metadata ValidationData: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRule' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRule' noNumbers: allOf: - $ref: '#/components/schemas/BasicRule' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRule' noNegative: allOf: - $ref: '#/components/schemas/BasicRule' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRule' regex: allOf: - $ref: '#/components/schemas/RegexRule' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRule' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRule' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRule' noPastDates: allOf: - $ref: '#/components/schemas/BasicRule' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRule' multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRule' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRule' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRule' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRule' externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRule' additionalProperties: false BasicRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata EmptyRuleDto: type: object additionalProperties: false description: Request DTO representing rule with no parameters MainEntityDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false BasicRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Request DTO representing basic validation rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false EvaluateDataGroupFieldsRequestDto: required: - dataGroupId type: object properties: dataGroupId: minLength: 1 type: string description: The UiD of the data group example: 84ec28e2-d786-417b-850f-96321dd849dd dataGroupVersionNumber: type: - integer - 'null' description: The version number of the data group format: int32 example: 1 data: type: - object - 'null' additionalProperties: type: string description: Data group properties for condition evaluation example: entityType: Company properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Entity data properties for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation additionalProperties: false description: Request DTO representing object used to evaluate the condition of data group fields ExternalProviderRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2' description: Static validation rule always applied when active additionalProperties: false RelatedFCRDto_2: type: object properties: status: type: - string - 'null' description: The status of the FCR. createdDate: type: string description: The date the FCR was created. format: date-time submittedDate: type: - string - 'null' description: The date the FCR was submitted. format: date-time additionalProperties: false ValueLimitRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false RelatedDocumentsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true documents: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDocumentDto_2' additionalProperties: false CollectionMinimumCountRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata ExternalDataAdapterDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false RelatedAssetsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssetDto_2' additionalProperties: false InvestmentAccountDto_2: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties of a single in-scope investment account additionalProperties: false CurrentDataGroupItemDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ScreeningMaterialityDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningMaterialityAssessmentDto_2' additionalProperties: false description: 'Data source for Screening Materiality Assessment outcomes. Contains a list of assessments — one per entity in the batch (main entity and related parties).' InvestmentAccountFundDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties of the single investment account fund additionalProperties: false BasicRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2' description: Static validation rule always applied when active additionalProperties: false SpecialCharactersRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata 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 externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c propertyTypeVersion: type: - integer - 'null' description: Property version format: int32 deprecated: true formulaSchema: allOf: - $ref: '#/components/schemas/NumberFormulaSchemaDto' description: Number formula schema dateTimePeriodFormulaSchema: allOf: - $ref: '#/components/schemas/DateTimePeriodFormulaSchemaDto' description: Date formula schema additionalProperties: false description: Response DTO representing data field data AlertDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: - string - 'null' type: type: - string - 'null' attribute: type: - string - 'null' additionalProperties: false DataGroupFieldDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupFieldDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data RelatedInvestmentManagerDataSource_2: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false CollectionMaximumCountRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2' description: Static validation rule always applied when active additionalProperties: false RelatedProductDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in product policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd lifecycleStatus: type: - string - 'null' description: System field used in backend for status of a product in lifecycle relationshipTypes: type: - array - 'null' items: type: string description: System field used in backend for product of a product relationship additionalProperties: false AutoCreditScreeningDto_2: type: object properties: entityId: type: string description: Entity Id format: uuid creditScreeningOutcome: type: - string - 'null' description: The outcome recorded for a manual screening task. properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy for auto credit screening example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd providerInternalIdentifier: type: - string - 'null' description: Provider Internal Identifier additionalProperties: false RelatedAssociationsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssociationDto_2' additionalProperties: false ValueLimitRule: type: object properties: active: type: boolean message: type: - string - 'null' minValue: type: - integer - 'null' format: int32 maxValue: type: - integer - 'null' format: int32 additionalProperties: false RelatedClientDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false CollectionMaximumCountRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata InvestmentAccountDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true investmentAccount: type: - array - 'null' items: $ref: '#/components/schemas/InvestmentAccountDto_2' additionalProperties: false CurrentUserDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: - array - 'null' items: type: string format: uuid isSystemUser: type: boolean additionalProperties: false CollateralDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RegexRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/RegexRuleDto2' description: Request DTO representing regex rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false DateLimitRule: type: object properties: active: type: boolean message: type: - string - 'null' minDate: type: - string - 'null' format: date-time maxDate: type: - string - 'null' format: date-time additionalProperties: false EvaluateDataGroupFieldsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDto' description: Request DTO representing object used to evaluate the condition of data group fields additionalProperties: false description: Service request data RegexRule: type: object properties: active: type: boolean message: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false RelatedDealsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDealDto_2' additionalProperties: false BasicRule: type: object properties: active: type: boolean message: 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: Request DTO representing validation data metadata additionalProperties: false description: Request DTO representing validation rule metadata RequirementDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/RequirementDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EvaluateRequirementSetsResponseDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EvaluateRequirementSetsResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data ScreeningMaterialityAssessmentDto_2: type: object properties: mainEntity: type: boolean description: Whether this assessment is for the main entity (true) or a related party (false). materialityOutcome: type: - string - 'null' description: Overall materiality outcome of the screening assessment (e.g. "Material", "Non-Material"). pepMaterialityStatus: type: - string - 'null' description: PEP (Politically Exposed Person) materiality status. sanctionsMaterialityStatus: type: - string - 'null' description: Sanctions materiality status. adverseMediaMaterialityStatus: type: - string - 'null' description: Adverse media materiality status. enforcementsMaterialityStatus: type: - string - 'null' description: Enforcements materiality status. otherMaterialityStatus: type: - string - 'null' description: Other (non-categorised) materiality status. pepJurisdictions: type: - array - 'null' items: type: string description: PEP jurisdictions associated with this assessment. sanctionsJurisdictions: type: - array - 'null' items: type: string description: Sanctions jurisdictions associated with this assessment. adverseMediaJurisdictions: type: - array - 'null' items: type: string description: Adverse media jurisdictions associated with this assessment. enforcementsJurisdictions: type: - array - 'null' items: type: string description: Enforcements jurisdictions associated with this assessment. otherJurisdictions: type: - array - 'null' items: type: string description: Other jurisdictions associated with this assessment. sanctionsProceedDecision: type: - string - 'null' description: Sanctions ok-to-proceed decision text returned by Screening (e.g. "Ok to proceed", "Not to proceed"). additionalProperties: false EventIngressDataSource_2: 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 description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/EmptyRuleDto' description: Request DTO representing rule with no parameters priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false NumberFormulaSchemaDto: type: object properties: formulaSetId: type: string format: uuid versionNumber: type: - integer - 'null' format: int32 formulaString: type: - string - 'null' formulaVariables: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/NumberFormulaVariableDto' additionalProperties: false RelatedPartiesDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyDto_2' additionalProperties: false DateLimitRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/DateLimitRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false CollectionMaximumCountRule: 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 InvestmentAccountRelatedFundShareClassDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties of the investment account related fund share class additionalProperties: false AlertAssessmentDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: - array - 'null' items: $ref: '#/components/schemas/AlertAssessmentDto_2' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto_2' lastAssessmentOutcome: type: - string - 'null' lastAssessmentDisposition: type: - string - 'null' additionalProperties: false RequirementDto: 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 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 dataProtectionJurisdiction: type: - string - 'null' description: Jurisdiction for data protection example: Global order: type: - number - 'null' description: Order format: double example: 1 defaultValue: type: - string - 'null' description: Default Value example: Not Available isReadOnly: type: boolean description: Is requirement readonly example: false isIndexable: type: boolean description: Is requirement indexable example: true isJourneyLevelData: type: boolean description: Is journey level data example: false 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 documentAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Document Access Layers acceptableDocumentDataKeys: type: - array - 'null' items: type: string description: List of acceptable Document Types for the Document Requirement fieldAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayerDto' description: Field Access Layers isMasked: type: boolean description: Flag indicating if field is masked due to missing Sensitive Data Access layers example: false 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: Request DTO representing validation data metadata 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? evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value tags: type: - array - 'null' items: type: string description: List of tags clearValueIfTriggerConditionNotMet: type: boolean description: Indicates whether the field value should be cleared when trigger conditions are not met example: false aggregateVersion: type: - integer - 'null' description: Requirement aggregate version format: int32 example: 1 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered portalGuidance: type: - string - 'null' description: Portal guidance example: Provide at least one director RP isLocked: type: boolean description: True if the aggregate is locked (obsolete) example: false deprecated: true discriminator: type: - string - 'null' description: Data group field core definition flag (obsolete) example: 'true' deprecated: true version: type: integer description: Requirement aggregate version (obsolete) format: int32 example: true deprecated: true partyCount: type: - integer - 'null' description: Requirement party count format: int32 example: 1 deprecated: true partyType: type: - string - 'null' description: Requirement party type example: Shareholder deprecated: true sourceEntityType: type: - string - 'null' description: Any of the related party entity types selected can be counted toward this requirement example: Individual deprecated: true additionalProperties: false description: Request DTO representing requirement metadata ExternalProviderRuleDto2: type: object properties: providerId: type: string description: Id of external provider. format: uuid additionalProperties: false description: Request DTO representing external provider rule metadata ConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: type: - string - 'null' description: Value that should be returned when conditions are met example: Relationship Manager priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 valueId: type: - string - 'null' description: Value Id that should be returned when conditions are met example: RM additionalProperties: false SpecialCharactersRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred excludedCharacters: type: - array - 'null' items: type: string description: Array of special characters, which will be ignored by validation e.g. ["!","@","#"] additionalProperties: false description: Request DTO representing special characters rule metadata ValueLimitRuleDtoValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2' description: Static validation rule always applied when active additionalProperties: false CurrentJourneysDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: - array - 'null' items: type: string additionalProperties: false ValidationRule: type: object properties: id: type: string format: uuid setId: type: string format: uuid propertyId: type: string format: uuid propertyTypeId: type: - string - 'null' format: uuid linkChildFieldPropertyName: type: - string - 'null' linkedParentFieldPropertyName: type: - string - 'null' propertyName: type: - string - 'null' friendlyName: type: - string - 'null' validationType: type: - string - 'null' isDataGroup: type: boolean dataGroupId: type: - string - 'null' format: uuid validationData: allOf: - $ref: '#/components/schemas/ValidationData' additionalProperties: false EmptyRuleDtoConditionalValidationRuleDto: type: object properties: isActive: type: boolean description: Validation rule active flag example: true staticRule: allOf: - $ref: '#/components/schemas/EmptyRuleDto' description: Static validation rule always applied when active dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto' description: Conditional validation rules additionalProperties: false NumberFormulaVariableDto: type: object properties: dataSource: type: - string - 'null' propertyName: type: - string - 'null' filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto' additionalProperties: false CollectionMaximumCountRuleDto2: type: object properties: errorMessage: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMaxCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with maximum count example: Registered: 1 overallMaximumCount: type: - integer - 'null' description: Overall maximum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection maximum count validation rule metadata ExternalProviderRule: type: object properties: active: type: boolean message: type: - string - 'null' providerId: type: string format: uuid additionalProperties: false EvaluateRequirementsRequestDtoServiceRequest: type: object properties: data: type: - object - 'null' additionalProperties: type: string description: Request DTO representing key-value pairs used to evaluate the condition of requirement example: entityType: Company additionalProperties: false description: Service request data RelatedUnderlyingPrincipalOwnerDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ManualCreditAssessmentV2DataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/CreditAssessmentDto_2' additionalProperties: false RelatedFCRsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true fcRs: type: - array - 'null' items: $ref: '#/components/schemas/RelatedFCRDto_2' additionalProperties: false ValueLimitRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata AlertAssessmentDto_2: type: object properties: category: type: - string - 'null' additionalProperties: false SpecialCharactersRule: type: object properties: active: type: boolean message: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false AccountRelatedFundDto_2: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false ReviewAndApprovalDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: - array - 'null' items: $ref: '#/components/schemas/ReviewAndApprovalDto_2' additionalProperties: false DataGroupFieldDto: type: object properties: identifier: type: string description: The UiD of the data group field format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Data group field name example: Product Type type: type: - string - 'null' description: Data group field type example: DataGroup order: type: - number - 'null' description: Data group field order format: double example: 2 dataField: allOf: - $ref: '#/components/schemas/DataFieldDto' description: Data group field data field isSensitiveData: type: boolean description: Data group field sensitive data flag example: true isCoreDefinition: type: boolean description: Data group field core definition flag example: true validationRule: allOf: - $ref: '#/components/schemas/ValidationRule' description: Data group field validation data validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto' description: Request DTO representing validation data metadata conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Data group field conditions list version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 defaultValue: type: - string - 'null' description: Default value for this data field example: Australia isReadOnly: type: boolean description: Is requirement readonly example: false 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 evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id description: type: - string - 'null' description: Data group field description example: This is the field description tags: type: - array - 'null' items: type: string description: List of tags example: - internal references: type: - array - 'null' items: $ref: '#/components/schemas/ReferenceDto' description: 'Data group field references list. Gated by the `DataGroupPolicyReferencesEnabled` feature flag: always null when the flag is disabled for the tenant; when enabled, reflects whatever references are stored for the field, which may itself be null if none exist.' additionalProperties: false description: Response DTO representing data group field data CreditAssessmentDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy for manual credit assessment example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd assessmentOutcome: type: - string - 'null' description: Assessment Outcome of this manual credit assessment assessmentComment: type: - string - 'null' description: Assessment Comment of this credit assessment taskId: type: - string - 'null' description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key additionalProperties: false RelatedDocumentDto_2: type: object properties: document: allOf: - $ref: '#/components/schemas/RelatedDocumentVersionedDto' additionalProperties: false CollateralDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: - array - 'null' items: $ref: '#/components/schemas/CollateralDto_2' additionalProperties: false RelatedDealDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false DateLimitRuleDtoConditionalValueDto: type: object properties: id: type: string description: The ID of the condition format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: The name of the condition example: Company-type only description: type: - string - 'null' description: The description of the condition example: Applicable only when EntityType=Company logicalOperation: type: - string - 'null' description: Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection example: AND operands: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDefinitionDto' description: Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto value: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2' description: Request DTO representing date limit rule metadata priority: type: integer description: Priority of the value in case when multiple conditional values are evaluated format: int32 example: 1 additionalProperties: false RelatedAssociationDto_2: type: object properties: associationType: type: - string - 'null' description: Type of this association example: 'Employee of ' ownershipPercentage: type: - number - 'null' description: Ownership Percentage of this association format: double example: 0.5 associationToClient: type: - string - 'null' description: Association To Client example: Direct/Indirect properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false AutoCreditAssessmentDto_2: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in policy for manual credit assessment example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd assessmentOutcome: type: - string - 'null' description: Assessment Outcome of this manual credit assessment providerInternalIdentifier: type: - string - 'null' description: Provider Internal Identifier additionalProperties: false RelatedProductsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: - array - 'null' items: $ref: '#/components/schemas/RelatedProductDto_2' additionalProperties: false AccountRelatedFundsDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: - array - 'null' items: $ref: '#/components/schemas/AccountRelatedFundDto_2' additionalProperties: false CurrentProductDataSource_2: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_2' description: Generic properties setup in product policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd lifecycleStatus: type: - string - 'null' description: System field used in backend for status of a product in lifecycle additionalProperties: false CollectionMinimumCountRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 description: Dictionary of required Primary Data Group Field values with minimum count example: Registered: 1 overallMinimumCount: type: integer description: Overall minimum count format: int32 example: 1 additionalProperties: false description: Request DTO representing collection minimum count validation rule metadata CollectionMinimumCountRule: 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_2: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto_2' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto_2' additionalProperties: false FilterConditionDto: type: object properties: fieldName: type: - string - 'null' description: Field name for the filter condition conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto' description: Conditions applied to the field additionalProperties: false DataValidationRulesDto: type: object properties: mandatory: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' description: Mandatory Rule - does not allow empty value specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto' description: 'Special characters validation rule - does not allow special characters, but allows define array of characters which can be ignored by the validation' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow numbers onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that allows numbers up to two decimal places regex: allOf: - $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto' description: Validation rule that validates the value against provided regex characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' description: Validation rule that allows to set minimum and maximum count of characters numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto' description: Validation rule that allows to set number range noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow future dates noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto' description: Validation rule that does not allow past dates dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto' description: Validation rule that allows to set selection range collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto' description: Validation rule that allows to set minimum count requirements for collection collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto' description: Validation rule that allows to set maximum count requirements for collection externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto' description: Validation rule that allows to use external provider for validation externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto' description: Validation rule that allows to use external provider for validation of one field with other fields as context readOnly: allOf: - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto' description: Validation rule that allows to set if field should be read only conditionalLimit: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto' description: Validation rule that validates the dynamic value against provided condition timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw additionalProperties: false description: Request DTO representing validation data metadata EntityAssociationDataSource_3: 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' description: Generic properties additionalProperties: false EntityDataMetadataDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: type: - string - 'null' additionalProperties: false ManualCreditScreeningDto_3: type: object properties: taskDataKey: type: - string - 'null' description: Task Data Key taskId: type: string description: Task Id format: uuid entityId: type: string description: Entity Id format: uuid creditScreeningOutcome: type: - string - 'null' description: The outcome recorded for a manual screening task. properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy for manual credit screening example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedPartyDto_3: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties setup in policy metadata: type: - object - 'null' additionalProperties: type: - string - 'null' description: The properties from the actual relationship additionalProperties: false ReviewAndApprovalDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy for review and approval task example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd approvalOutcome: type: - string - 'null' description: The Approval Outcome of the task approvalReason: type: - string - 'null' description: The Reason of the approval decision. taskId: type: - string - 'null' description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key additionalProperties: false ChangedFieldsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: - array - 'null' items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false RelatedAssetDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false AutoCreditScreeningDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto_3' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto_3' additionalProperties: false SignificanceEngineDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false PropertyDto_3: 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' JourneyLevelDataDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false AutoCreditAssessmentDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditAssessmentDto_3' additionalProperties: false MainEntityDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' 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 EvaluateDataGroupFieldsRequestDto_2: required: - dataGroupId type: object properties: dataGroupId: minLength: 1 type: string description: The UiD of the data group example: 84ec28e2-d786-417b-850f-96321dd849dd dataGroupVersionNumber: type: - integer - 'null' description: The version number of the data group format: int32 example: 1 data: type: - object - 'null' additionalProperties: type: string description: Data group properties for condition evaluation example: entityType: Company properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Entity data properties for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation additionalProperties: false description: Request DTO representing object used to evaluate the condition of data group fields RelatedFCRDto_3: type: object properties: status: type: - string - 'null' description: The status of the FCR. createdDate: type: string description: The date the FCR was created. format: date-time submittedDate: type: - string - 'null' description: The date the FCR was submitted. format: date-time additionalProperties: false EvaluateRequirementsRequestV2Dto: type: object properties: jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: List of versioned jurisdiction requirementTypes: type: - array - 'null' items: type: string description: List of requirement types [Data, Document, OwnershipAndControl] data: type: - object - 'null' additionalProperties: type: - string - 'null' description: Key-Value pair of data to evaluate deprecated: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Entity data properties for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd targetEntity: type: - string - 'null' description: Target entity example: Client categories: type: - array - 'null' items: type: string description: List of requirement category e.g. ["Basic Details", "Enrich Details"] additionalProperties: false description: Request DTO representing object used to evaluate the condition of requirement RelatedDocumentsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true documents: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDocumentDto_3' additionalProperties: false ExternalDataAdapterDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false RelatedAssetsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssetDto_3' additionalProperties: false InvestmentAccountDto_3: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties of a single in-scope investment account additionalProperties: false CurrentDataGroupItemDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ScreeningMaterialityDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: - array - 'null' items: $ref: '#/components/schemas/ScreeningMaterialityAssessmentDto_3' additionalProperties: false description: 'Data source for Screening Materiality Assessment outcomes. Contains a list of assessments — one per entity in the batch (main entity and related parties).' InvestmentAccountFundDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties of the single investment account fund additionalProperties: false AlertDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: - string - 'null' type: type: - string - 'null' attribute: type: - string - 'null' additionalProperties: false EvaluateRequirementsRequestV2DtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV2Dto' description: Request DTO representing object used to evaluate the condition of requirement additionalProperties: false description: Service request data RelatedInvestmentManagerDataSource_3: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false RelatedProductDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in product policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd lifecycleStatus: type: - string - 'null' description: System field used in backend for status of a product in lifecycle relationshipTypes: type: - array - 'null' items: type: string description: System field used in backend for product of a product relationship additionalProperties: false AutoCreditScreeningDto_3: type: object properties: entityId: type: string description: Entity Id format: uuid creditScreeningOutcome: type: - string - 'null' description: The outcome recorded for a manual screening task. properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy for auto credit screening example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd providerInternalIdentifier: type: - string - 'null' description: Provider Internal Identifier additionalProperties: false RelatedAssociationsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssociationDto_3' additionalProperties: false RelatedClientDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false InvestmentAccountDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true investmentAccount: type: - array - 'null' items: $ref: '#/components/schemas/InvestmentAccountDto_3' additionalProperties: false CurrentUserDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: - array - 'null' items: type: string format: uuid isSystemUser: type: boolean additionalProperties: false CollateralDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedDealsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDealDto_3' additionalProperties: false ScreeningMaterialityAssessmentDto_3: type: object properties: mainEntity: type: boolean description: Whether this assessment is for the main entity (true) or a related party (false). materialityOutcome: type: - string - 'null' description: Overall materiality outcome of the screening assessment (e.g. "Material", "Non-Material"). pepMaterialityStatus: type: - string - 'null' description: PEP (Politically Exposed Person) materiality status. sanctionsMaterialityStatus: type: - string - 'null' description: Sanctions materiality status. adverseMediaMaterialityStatus: type: - string - 'null' description: Adverse media materiality status. enforcementsMaterialityStatus: type: - string - 'null' description: Enforcements materiality status. otherMaterialityStatus: type: - string - 'null' description: Other (non-categorised) materiality status. pepJurisdictions: type: - array - 'null' items: type: string description: PEP jurisdictions associated with this assessment. sanctionsJurisdictions: type: - array - 'null' items: type: string description: Sanctions jurisdictions associated with this assessment. adverseMediaJurisdictions: type: - array - 'null' items: type: string description: Adverse media jurisdictions associated with this assessment. enforcementsJurisdictions: type: - array - 'null' items: type: string description: Enforcements jurisdictions associated with this assessment. otherJurisdictions: type: - array - 'null' items: type: string description: Other jurisdictions associated with this assessment. sanctionsProceedDecision: type: - string - 'null' description: Sanctions ok-to-proceed decision text returned by Screening (e.g. "Ok to proceed", "Not to proceed"). additionalProperties: false EventIngressDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false RelatedPartiesDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyDto_3' additionalProperties: false InvestmentAccountRelatedFundShareClassDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Properties of the investment account related fund share class additionalProperties: false AlertAssessmentDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: - array - 'null' items: $ref: '#/components/schemas/AlertAssessmentDto_3' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto_3' lastAssessmentOutcome: type: - string - 'null' lastAssessmentDisposition: type: - string - 'null' additionalProperties: false CurrentJourneysDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: - array - 'null' items: type: string additionalProperties: false RelatedUnderlyingPrincipalOwnerDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ManualCreditAssessmentV2DataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/CreditAssessmentDto_3' additionalProperties: false RelatedFCRsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true fcRs: type: - array - 'null' items: $ref: '#/components/schemas/RelatedFCRDto_3' additionalProperties: false AlertAssessmentDto_3: type: object properties: category: type: - string - 'null' additionalProperties: false AccountRelatedFundDto_3: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false ReviewAndApprovalDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: - array - 'null' items: $ref: '#/components/schemas/ReviewAndApprovalDto_3' additionalProperties: false CreditAssessmentDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy for manual credit assessment example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd assessmentOutcome: type: - string - 'null' description: Assessment Outcome of this manual credit assessment assessmentComment: type: - string - 'null' description: Assessment Comment of this credit assessment taskId: type: - string - 'null' description: Task Id taskDataKey: type: - string - 'null' description: Task Data Key additionalProperties: false RelatedDocumentDto_3: type: object properties: document: allOf: - $ref: '#/components/schemas/RelatedDocumentVersionedDto' additionalProperties: false CollateralDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: - array - 'null' items: $ref: '#/components/schemas/CollateralDto_3' additionalProperties: false RelatedDealDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd additionalProperties: false RelatedAssociationDto_3: type: object properties: associationType: type: - string - 'null' description: Type of this association example: 'Employee of ' ownershipPercentage: type: - number - 'null' description: Ownership Percentage of this association format: double example: 0.5 associationToClient: type: - string - 'null' description: Association To Client example: Direct/Indirect properties: allOf: - $ref: '#/components/schemas/PropertiesDto' description: Generic properties additionalProperties: false AutoCreditAssessmentDto_3: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in policy for manual credit assessment example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd assessmentOutcome: type: - string - 'null' description: Assessment Outcome of this manual credit assessment providerInternalIdentifier: type: - string - 'null' description: Provider Internal Identifier additionalProperties: false RelatedProductsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: - array - 'null' items: $ref: '#/components/schemas/RelatedProductDto_3' additionalProperties: false AccountRelatedFundsDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: - array - 'null' items: $ref: '#/components/schemas/AccountRelatedFundDto_3' additionalProperties: false CurrentProductDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_3' description: Generic properties setup in product policy example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd lifecycleStatus: type: - string - 'null' description: System field used in backend for status of a product in lifecycle additionalProperties: false ManualCreditScreeningDataSource_3: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto_3' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto_3' additionalProperties: false EvaluatedAllRequirementsNormalizedResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluatedAllRequirementsNormalizedResponseDto' description: 'Normalized variant of Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.EvaluatedAllRequirementsResponseDto: each data group''s unique evaluated fields are listed once in `evaluatedFields` and items reference them by index, cutting payload size for data groups with many similar items. All other collections are unchanged.' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 EvaluatedAllRequirementsReadOnlyNormalizedResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyNormalizedResponseDto' description: 'Normalized variant of Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.EvaluatedAllRequirementsReadOnlyResponseDto: each data group''s unique evaluated fields are listed once in `evaluatedFields` and items reference them by index, cutting payload size for data groups with many similar items. All other collections are unchanged.' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EvaluatedAllRequirementsReadOnlyResponseDto: type: object properties: evaluatedSingleDataRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedSingleDataRequirementReadOnlyDto' description: Evaluated single data requirements evaluatedDataGroupRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupRequirementReadOnlyDto' description: Evaluated data group requirements additionalProperties: false EvaluateAllRequirementsRequestDto: required: - entityType - jurisdictions - properties - requirementType type: object properties: jurisdictions: minItems: 1 type: array items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the requirement in specific version requirementType: minLength: 1 type: string description: Requirement type [Data, Document, OwnershipAndControl] example: Data targetEntity: type: - string - 'null' description: Target entity example: Client entityType: minLength: 1 type: string 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 additionalProperties: $ref: '#/components/schemas/PropertyDto_4' description: Entity data properties used for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation journeyId: type: - string - 'null' description: Id of the journey used to determine data group version retrieved from the baseline format: uuid entityId: type: - string - 'null' description: Id of the entity which is used to fetch all Related Products in the Journey format: uuid journeyLevelDataOnly: type: boolean description: Flag indicating if returned requirements will be Journey Level Data only example: false fetchDataSources: type: - array - 'null' items: type: string description: Array indicating if all related products should be fetched for the entity example: - relatedProducts taskId: type: - string - 'null' description: Id of the task associated with this evaluation request format: uuid skipValuesEvaluation: type: boolean description: 'Skip evaluation of default value, conditional value and calculated fields if value is true. Use ''true'' for readonly/completed tasks. Default value will be false.' example: false additionalProperties: false EvaluatedAllRequirementsReadOnlyNormalizedResponseDto: type: object properties: evaluatedSingleDataRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedSingleDataRequirementReadOnlyDto' description: Evaluated single data requirements evaluatedDataGroupRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupRequirementReadOnlyNormalizedDto' description: Evaluated data group requirements (normalized) additionalProperties: false description: 'Normalized variant of Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.EvaluatedAllRequirementsReadOnlyResponseDto: each data group''s unique evaluated fields are listed once in `evaluatedFields` and items reference them by index, cutting payload size for data groups with many similar items. All other collections are unchanged.' EvaluateRequirementsRequestV3DtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateRequirementsRequestV3Dto' description: Request DTO representing object used to evaluate the condition of requirement additionalProperties: false description: Service request data 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 externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c 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: Request DTO representing validation data metadata 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 evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id 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 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw validationErrors: type: - array - 'null' items: $ref: '#/components/schemas/FieldValidationErrorDto' description: Evaluated validation errors for this field shouldClearValue: type: boolean description: Whether the field value should be cleared to null because all trigger conditions are not met example: false jurisdiction: type: - string - 'null' description: Requirement jurisdiction example: Global isIndexable: type: boolean description: Requirement is indexed for search example: true isMaterialData: type: boolean description: Requirement material data flag example: true additionalProperties: false EvaluatedAllRequirementsResponseDto: 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 evaluatedESignatureDocumentRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedESignatureDocumentRequirementDto' description: Evaluated eSignature document requirements additionalProperties: false EvaluatedDataGroupItemRefsDto: type: object properties: evaluatedFieldRefs: type: - array - 'null' items: type: integer format: int32 description: 'Ordered, zero-based indices into the parent requirement''s `evaluatedFields` list. Request-time-valid only — not stable across requests, so resolve against the same response.' example: - 0 - 3 - 3 - 7 additionalProperties: false description: A data group item that references its evaluated fields by index instead of inlining them. CalculatedResultDto: type: object properties: result: type: - string - 'null' description: Calculation result example: '42.5' error: type: - string - 'null' description: Calculation error example: Division by zero additionalProperties: false PropertyDto_4: 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' EvaluateRequirementSetsRequestV2DtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateRequirementSetsRequestV2Dto' description: Request DTO representing entity data properties used to evaluate the condition of requirement set additionalProperties: false description: Service request data EvaluatedDataGroupRequirementReadOnlyDto: 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 category: type: - string - 'null' description: Requirement business category example: Basic Details order: type: - number - 'null' description: Order format: double example: 1 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 additionalProperties: false EvaluatedDocumentRequirementDto: type: object properties: id: type: string description: The UiD of the requirement format: uuid example: 84ec28e2-d786-417b-850f-96321dd849dd 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 acceptableDocumentDataKeys: type: - array - 'null' items: type: string description: List of acceptable documents additionalProperties: false EvaluateRequirementsRequestV3Dto: type: object properties: jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: List of versioned jurisdiction requirementTypes: type: - array - 'null' items: type: string description: List of requirement types [Data, Document, OwnershipAndControl] properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_4' description: Entity data properties for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation targetEntity: type: - string - 'null' description: Target entity example: Client categories: type: - array - 'null' items: type: string description: List of requirement category e.g. ["Basic Details", "Enrich Details"] additionalProperties: false description: Request DTO representing object used to evaluate the condition of requirement EvaluatedESignatureDocumentRequirementDto: type: object properties: id: type: - string - 'null' description: Unique identifier of the eSignature document requirement name: type: - string - 'null' description: Requirement name dataKey: type: - string - 'null' description: Data key description: type: - string - 'null' description: Requirement description isRequired: type: boolean description: Whether the requirement is mandatory isConditional: type: boolean description: Whether the requirement is conditional acceptableDocumentDataKeys: type: - array - 'null' items: type: string description: List of acceptable document data keys additionalProperties: false EvaluatedDataGroupRequirementNormalizedDto: type: object properties: propertyName: type: - string - 'null' description: Property name of data group requirement example: firstName dataGroupId: type: string description: The ID 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: Request DTO representing validation data metadata 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 evaluatedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupFieldDto' description: 'Unique evaluated fields for this data group, stored once each. Items reference entries by index (see Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.Normalized.EvaluatedDataGroupItemRefsDto.EvaluatedFieldRefs).' evaluatedItems: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/EvaluatedDataGroupItemRefsDto' description: Evaluated data group items, keyed by item id, each referencing Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.Normalized.EvaluatedDataGroupRequirementNormalizedDto.EvaluatedFields by index. example: itemId: evaluatedFieldRefs: - 0 - 1 isConditional: type: boolean description: Is requirement conditional example: false additionalProperties: false description: 'Normalized projection of an evaluated data group requirement: unique evaluated fields listed once in Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.Normalized.EvaluatedDataGroupRequirementNormalizedDto.EvaluatedFields, with each item referencing them by index. Otherwise identical to Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.EvaluatedDataGroupRequirementDto.' EvaluatedAllRequirementsReadOnlyResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluatedAllRequirementsReadOnlyResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data EvaluatedDataGroupItemDto: type: object properties: evaluatedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupFieldDto' description: Evaluated data group fields additionalProperties: false EvaluateAllRequirementsReadOnlyRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsReadOnlyRequestDto' description: The service request DTO additionalProperties: false description: Service request data EvaluateRequirementsInScopeV2RequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateRequirementsInScopeV2RequestDto' description: The service request DTO additionalProperties: false description: Service request data EvaluatedSingleDataRequirementReadOnlyDto: 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 jurisdiction: type: - string - 'null' description: Requirement jurisdiction example: Global name: type: - string - 'null' description: Requirement name example: First Name description: type: - string - 'null' description: Requirement description example: This is the client first name category: type: - string - 'null' description: Requirement business category example: Basic Details order: type: - number - 'null' description: Order format: double example: 1 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 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered additionalProperties: false EvaluateRequirementsInScopeV2RequestDto: required: - entityType - jurisdictions - requirementType type: object properties: jurisdictions: minItems: 1 type: array items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the requirement in specific version requirementType: minLength: 1 type: string description: Requirement type [Data, Document, OwnershipAndControl] example: Data targetEntity: type: - string - 'null' description: Target entity example: Client entityType: minLength: 1 type: string 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_4' description: Entity data properties used for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation returnValidationErrors: type: boolean description: Run validation and return errors for each data requirement 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: Request DTO representing validation data metadata 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 additionalProperties: false EvaluatedDataGroupRequirementReadOnlyNormalizedDto: 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 category: type: - string - 'null' description: Requirement business category example: Basic Details order: type: - number - 'null' description: Order format: double example: 1 columns: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupColumnDto' description: All data group columns evaluatedFields: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedDataGroupFieldDto' description: 'Unique evaluated fields for this data group, stored once each. Items reference entries by index (see Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.Normalized.EvaluatedDataGroupItemRefsDto.EvaluatedFieldRefs).' evaluatedItems: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/EvaluatedDataGroupItemRefsDto' description: Evaluated data group items, keyed by item id, each referencing Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.Normalized.EvaluatedDataGroupRequirementReadOnlyNormalizedDto.EvaluatedFields by index. example: itemId: evaluatedFieldRefs: - 0 - 1 isConditional: type: boolean description: Is requirement conditional example: false additionalProperties: false description: 'Normalized projection of an evaluated read-only data group requirement: unique evaluated fields listed once in Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.Normalized.EvaluatedDataGroupRequirementReadOnlyNormalizedDto.EvaluatedFields, with each item referencing them by index. Otherwise identical to Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.EvaluatedDataGroupRequirementReadOnlyDto.' AlertAssessmentDataSource_4: required: - assessments - lastAssessment type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: minItems: 1 type: array items: $ref: '#/components/schemas/AlertAssessmentDto' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto' lastAssessmentOutcome: type: - string - 'null' lastAssessmentDisposition: type: - string - 'null' additionalProperties: false FieldValidationErrorDto: type: object properties: validator: type: - string - 'null' description: Type of the validator that returned error message example: mandatory message: type: - string - 'null' description: Error message configured by the user in the Policy example: This field is required additionalProperties: false EvaluateRequirementSetsRequestV2Dto: required: - properties type: object properties: properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto_4' description: Entity data properties for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation entityId: type: - string - 'null' description: 'Entity/journey/task this request concerns. When Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementSets.v2.EvaluateRequirementSetsRequestV2Dto.EntityId is supplied (and Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementSets.v2.EvaluateRequirementSetsRequestV2Dto.JourneyId/Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementSets.v2.EvaluateRequirementSetsRequestV2Dto.TaskId, unless the tenant has EnableFetchAllRelatedProductsWithoutJourneyOrTaskId enabled), lets Policy re-fetch Related Products directly rather than trust the caller-supplied data source (see AB#537936). Full population is not required in all cases; the exact gating is tenant-flag dependent.' format: uuid journeyId: type: - string - 'null' description: Journey this request concerns. See Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementSets.v2.EvaluateRequirementSetsRequestV2Dto.EntityId. format: uuid taskId: type: - string - 'null' description: Task this request concerns. See Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementSets.v2.EvaluateRequirementSetsRequestV2Dto.EntityId. format: uuid additionalProperties: false description: Request DTO representing entity data properties used to evaluate the condition of requirement set EvaluatedOwnershipAndControlRequirementDto: type: object properties: 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 portalGuidance: type: - string - 'null' description: Portal guidance example: Provide at least one director RP additionalProperties: false EvaluatedAllRequirementsNormalizedResponseDto: 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/EvaluatedDataGroupRequirementNormalizedDto' description: Evaluated data group requirements (normalized) 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 evaluatedESignatureDocumentRequirements: type: - array - 'null' items: $ref: '#/components/schemas/EvaluatedESignatureDocumentRequirementDto' description: Evaluated eSignature document requirements additionalProperties: false description: 'Normalized variant of Fenergo.Nebula.Policy.Query.Application.V1.Features.EvaluateRequirementsInScope.V2.ResponseDto.EvaluatedAllRequirementsResponseDto: each data group''s unique evaluated fields are listed once in `evaluatedFields` and items reference them by index, cutting payload size for data groups with many similar items. All other collections are unchanged.' EvaluateAllRequirementsReadOnlyRequestDto: required: - entityType - jurisdictions - properties - requirementType type: object properties: jurisdictions: minItems: 1 type: array items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: Jurisdictions of the requirement in specific version requirementType: minLength: 1 type: string description: Requirement type [Data, Document, OwnershipAndControl] example: Data targetEntity: type: - string - 'null' description: Target entity example: Client entityType: minLength: 1 type: string 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 additionalProperties: $ref: '#/components/schemas/PropertyDto_4' description: Entity data properties used for condition evaluation example: firstName: type: Single value: Tom dateOfBirth: type: Single value: '2021-07-15' address: type: Collection dataGroupId: dfde9f06-040a-4127-b9a0-2c802a6502fc collections: 54a25d24-1a4b-45c6-a5b4-980e5d3a1df5: properties: country: Ireland city: Dublin street: Mayor Street 47010265-3b85-4407-be61-90d04525f020: properties: country: Ireland city: Dublin street: E Wall Rd dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto' description: Additional data sources used for evaluation journeyId: type: - string - 'null' description: Id of the journey used to determine data group version retrieved from the baseline format: uuid entityId: type: - string - 'null' description: Id of the entity which is used to fetch all Related Products in the Journey format: uuid journeyLevelDataOnly: type: boolean description: Flag indicating if returned requirements will be Journey Level Data only example: false fetchDataSources: type: - array - 'null' items: type: string description: Array indicating if all related products should be fetched for the entity example: - relatedProducts taskId: type: - string - 'null' description: Id of the task associated with this evaluation request format: uuid additionalProperties: false DataGroupColumnDto: 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 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 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 externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c 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: Request DTO representing validation data metadata 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 evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id 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 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw validationErrors: type: - array - 'null' items: $ref: '#/components/schemas/FieldValidationErrorDto' description: Evaluated validation errors for this field shouldClearValue: type: boolean description: Whether the field value should be cleared to null because all trigger conditions are not met example: false additionalProperties: false EvaluatedAllRequirementsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluatedAllRequirementsResponseDto' description: The service response DTO messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response additionalProperties: false description: Service response data 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 externalSearchApiProviderId: type: - string - 'null' description: External search api provider id format: uuid example: ab92ecbc-bd77-494b-acad-3d2fb0b8136c 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: Request DTO representing validation data metadata 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 evaluatedConditionalValueId: type: - string - 'null' description: Evaluated conditional value Id 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 uiDecoration: type: - string - 'null' description: Determines how the requirement should be rendered uiColorDecoration: type: - string - 'null' description: Determines with what colour requirement should be rendered hasCalculatedValue: type: boolean description: Does this field has calculated value? calculatedFieldResult: allOf: - $ref: '#/components/schemas/CalculatedResultDto' description: Calcualtion value timeZoneId: type: - string - 'null' description: Time zone id used for date values validation in order to determine exact Today time range example: Europe/Warsaw validationErrors: type: - array - 'null' items: $ref: '#/components/schemas/FieldValidationErrorDto' description: Evaluated validation errors for this field shouldClearValue: type: boolean description: Whether the field value should be cleared to null because all trigger conditions are not met example: false additionalProperties: false EvaluateAllRequirementsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateAllRequirementsRequestDto' description: The service request DTO additionalProperties: false description: Service request data CollectionMinimumCountRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto2_2' additionalProperties: false ProductRequestDataDto: type: object properties: productId: type: string format: uuid properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' currentProductMetadata: allOf: - $ref: '#/components/schemas/CurrentProductMetadataDataSource' additionalProperties: false ValueLimitRuleDtoConditionalValueDto_2: 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_2' value: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' priority: type: integer format: int32 additionalProperties: false EntityAssociationDataSource_4: 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_2: type: object properties: active: type: boolean message: type: - string - 'null' providerId: type: string format: uuid 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 SpecialCharactersRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto2_2' 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_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDto_2' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' regex: allOf: - $ref: '#/components/schemas/RegexRuleDto_2' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDto2_2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDto_2' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto_2' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto_2' externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto_2' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Validation rule that does not allow todays date additionalProperties: false description: Request DTO representing validation data metadata EntityDataMetadataDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true entityType: type: - string - 'null' additionalProperties: false ManualCreditScreeningDto_4: 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_5' additionalProperties: false RelatedPartyDto_4: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' metadata: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false ReviewAndApprovalDto_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' approvalOutcome: type: - string - 'null' approvalReason: type: - string - 'null' taskId: type: - string - 'null' taskDataKey: type: - string - 'null' additionalProperties: false BasicRuleDto_2: type: object properties: active: type: boolean message: type: - string - 'null' additionalProperties: false ConditionDto_2: 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_2' additionalProperties: false ChangedFieldsDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true changedFields: type: - array - 'null' items: $ref: '#/components/schemas/ChangedFieldDto' additionalProperties: false RegexRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/RegexRuleDto2_2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/RegexRuleDtoConditionalValueDto_2' additionalProperties: false ServiceResponse_2: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false OwnershipValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Mandatory requirement partyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' 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_2' description: Is the unwrapping requirement non-calculable? idvIsMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto_2' description: Mandatory ID&V idvPartyCount: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto_2' 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_2' description: Do all entities that meet the criteria of this requirement need to be ID&Vd? additionalProperties: false ValueField_2: type: object properties: dataSource: type: - string - 'null' field: type: - string - 'null' additionalProperties: false RelatedAssetDto_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' additionalProperties: false ValueLimitRuleDto2_2: type: object properties: errorMessage: type: - string - 'null' minValue: type: - integer - 'null' format: int32 maxValue: type: - integer - 'null' format: int32 additionalProperties: false EvaluateProductRequirementsRequestDto: type: object properties: jurisdictions: type: - array - 'null' items: $ref: '#/components/schemas/VersionedJurisdictionDto' description: List of versioned jurisdiction requirementTypes: type: - array - 'null' items: type: string description: List of product requirement types [Data, Document] properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' description: Entity data properties for condition evaluation dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto_2' description: Additional data sources used for evaluation targetEntity: type: - string - 'null' description: Target entity example: Product categories: type: - array - 'null' items: type: string description: List of product requirement category e.g. ["Basic Details", "Enrich Details"] sourceEntityId: type: - string - 'null' description: The ID of the product being evaluated journeyId: type: - string - 'null' description: The ID of the Journey which initiated the request additionalProperties: false description: Request DTO representing object used to evaluate the condition of product requirement example: entityType: Company ConditionDefinitionDto_2: 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_2' valueField: allOf: - $ref: '#/components/schemas/ValueField_2' additionalProperties: false EvaluateProductsResponseDto: type: object properties: productIds: type: - array - 'null' items: type: string format: uuid description: The UiDs of the products that met scoping rule example: - 84ec28e2-d786-417b-850f-96321dd849dd additionalProperties: false description: Response DTO representing collection of evaluated product ids RegexRuleDto_2: type: object properties: active: type: boolean message: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false DateLimitRangeData: 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 BasicRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/BasicRuleDtoConditionalValueDto_2' 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_2' value: allOf: - $ref: '#/components/schemas/DateLimitRuleDto4' priority: type: integer format: int32 additionalProperties: false DateTimePeriodFormulaSchemaDto_2: 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 EvaluateProductsRequestDto: type: object properties: scopingRuleSetVersionId: type: - string - 'null' description: The UiD of the scopingRuleSetVersionId example: 84ec28e2-d786-417b-850f-96321dd849dd products: type: - array - 'null' items: $ref: '#/components/schemas/ProductRequestDataDto' description: Products data to check for scoping dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto_2' description: Additional data sources used for evaluation additionalProperties: false description: Request DTO representing object used to evaluate the collection of product ids in scope CalculatedResultDto_2: type: object properties: result: type: - string - 'null' description: Calculation result error: type: - string - 'null' description: Calculation error additionalProperties: false AutoCreditScreeningDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto_4' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditScreeningDto_4' additionalProperties: false SignificanceEngineDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDto' additionalProperties: false RegexRuleDto2_2: type: object properties: errorMessage: type: - string - 'null' isCaseSensitive: type: boolean regexValue: type: - string - 'null' additionalProperties: false JourneyLevelDataDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false PropertyDto_5: 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_2: 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 AutoCreditAssessmentDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true autoCreditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/AutoCreditAssessmentDto_4' additionalProperties: false ReferenceDto_2: 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_2: 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 ValidationData_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRule' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRule' noNumbers: allOf: - $ref: '#/components/schemas/BasicRule' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRule' noNegative: allOf: - $ref: '#/components/schemas/BasicRule' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRule' regex: allOf: - $ref: '#/components/schemas/RegexRule' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRule' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRule' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRule' noPastDates: allOf: - $ref: '#/components/schemas/BasicRule' multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRule' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRule' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRule' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRule' externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRule' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRule' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRule_2' additionalProperties: false BasicRuleDto2_2: type: object properties: errorMessage: type: - string - 'null' additionalProperties: false EmptyRuleDto_2: type: object additionalProperties: false MainEntityDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false EvaluateProductRequirementSetsResponseDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/EvaluateProductRequirementSetsResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false BasicRuleDtoConditionalValueDto_2: 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_2' value: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' priority: type: integer format: int32 additionalProperties: false EvaluateDataGroupFieldsRequestDto_3: type: object properties: dataGroupId: type: - string - 'null' description: The UiD of the data group example: 84ec28e2-d786-417b-850f-96321dd849dd dataGroupVersionNumber: type: - integer - 'null' description: The version number of the data group format: int32 example: 1 data: type: - object - 'null' additionalProperties: type: string description: Key-Value pair of data to evaluate example: entityType: Company deprecated: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' description: Entity data properties for condition evaluation dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto_2' description: Additional data sources used for evaluation additionalProperties: false description: Request DTO representing object used to evaluate the condition of data group fields ExternalProviderRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDto2_2' additionalProperties: false ValueLimitRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValueDto_2' additionalProperties: false EvaluateProductsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateProductsRequestDto' description: Request DTO representing object used to evaluate the collection of product ids in scope additionalProperties: false CollectionMinimumCountRuleDto2_2: type: object properties: errorMessage: type: - string - 'null' requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 overallMinimumCount: type: integer format: int32 additionalProperties: false ExternalDataAdapterDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false RelatedAssetsDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true assets: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssetDto_4' additionalProperties: false CurrentDataGroupItemDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: type: - string - 'null' additionalProperties: false InvestmentAccountFundDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false BasicRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/BasicRuleDto2_2' additionalProperties: false SpecialCharactersRuleDto_2: type: object properties: active: type: boolean message: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false DataSourcesDto_2: type: object properties: entityDataMetadata: allOf: - $ref: '#/components/schemas/EntityDataMetadataDataSource_4' eventIngress: allOf: - $ref: '#/components/schemas/EventIngressDataSource_4' changedFields: allOf: - $ref: '#/components/schemas/ChangedFieldsDataSource_4' relatedClient: allOf: - $ref: '#/components/schemas/RelatedClientDataSource_4' relatedProducts: allOf: - $ref: '#/components/schemas/RelatedProductsDataSource_4' currentDataGroupItem: allOf: - $ref: '#/components/schemas/CurrentDataGroupItemDataSource_4' externalDataAdapter: allOf: - $ref: '#/components/schemas/ExternalDataAdapterDataSource_4' entityAssociation: allOf: - $ref: '#/components/schemas/EntityAssociationDataSource_4' manualCreditAssessment: allOf: - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource_4' reviewAndApproval: allOf: - $ref: '#/components/schemas/ReviewAndApprovalDataSource_4' autoCreditAssessment: allOf: - $ref: '#/components/schemas/AutoCreditAssessmentDataSource_4' manualCreditScreening: allOf: - $ref: '#/components/schemas/ManualCreditScreeningDataSource_4' collateral: allOf: - $ref: '#/components/schemas/CollateralDataSource_4' currentJourneys: allOf: - $ref: '#/components/schemas/CurrentJourneysDataSource_4' autoCreditScreening: allOf: - $ref: '#/components/schemas/AutoCreditScreeningDataSource_4' currentProduct: allOf: - $ref: '#/components/schemas/CurrentProductDataSource_4' relatedDeals: allOf: - $ref: '#/components/schemas/RelatedDealsDataSource_4' mainEntity: allOf: - $ref: '#/components/schemas/MainEntityDataSource_4' relatedAssets: allOf: - $ref: '#/components/schemas/RelatedAssetsDataSource_4' relatedAssociations: allOf: - $ref: '#/components/schemas/RelatedAssociationsDataSource_4' accountRelatedFunds: allOf: - $ref: '#/components/schemas/AccountRelatedFundsDataSource_4' investmentAccountFund: allOf: - $ref: '#/components/schemas/InvestmentAccountFundDataSource_4' journeyLevelData: allOf: - $ref: '#/components/schemas/JourneyLevelDataDataSource_4' relatedParties: allOf: - $ref: '#/components/schemas/RelatedPartiesDataSource_4' currentField: allOf: - $ref: '#/components/schemas/CurrentFieldDataSource' significanceEngine: allOf: - $ref: '#/components/schemas/SignificanceEngineDataSource_4' alert: allOf: - $ref: '#/components/schemas/AlertDataSource_4' relatedInvestmentManager: allOf: - $ref: '#/components/schemas/RelatedInvestmentManagerDataSource_4' relatedUnderlyingPrincipalOwner: allOf: - $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource_4' alertAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDataSource_5' currentProductMetadata: allOf: - $ref: '#/components/schemas/CurrentProductMetadataDataSource' currentUser: allOf: - $ref: '#/components/schemas/CurrentUserDataSource_4' additionalProperties: false DataFieldDto_2: 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_2' 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_4: type: object properties: dataSource: type: - string - 'null' readOnly: true source: type: - string - 'null' type: type: - string - 'null' attribute: type: - string - 'null' additionalProperties: false DataGroupFieldDtoIEnumerableServiceResponse_2: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/DataGroupFieldDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false RelatedInvestmentManagerDataSource_4: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' dataSource: type: - string - 'null' readOnly: true additionalProperties: false CollectionMaximumCountRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDto2_2' additionalProperties: false RelatedProductDto_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' lifecycleStatus: type: - string - 'null' relationshipTypes: type: - array - 'null' items: type: string additionalProperties: false AutoCreditScreeningDto_4: type: object properties: entityId: type: string format: uuid creditScreeningOutcome: type: - string - 'null' properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' providerInternalIdentifier: type: - string - 'null' additionalProperties: false RelatedAssociationsDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedAssociations: type: - array - 'null' items: $ref: '#/components/schemas/RelatedAssociationDto_4' additionalProperties: false RelatedClientDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' 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_2: 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_4: type: object properties: dataSource: type: - string - 'null' readOnly: true teamIds: type: - array - 'null' items: type: string format: uuid isSystemUser: type: boolean additionalProperties: false EvaluateProductsResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateProductsResponseDto' description: Response DTO representing collection of evaluated product ids messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false CollateralDto_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' additionalProperties: false RegexRuleDtoConditionalValueDto_2: 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_2' value: allOf: - $ref: '#/components/schemas/RegexRuleDto2_2' priority: type: integer format: int32 additionalProperties: false EvaluateProductRequirementsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementsRequestDto' description: Request DTO representing object used to evaluate the condition of product requirement example: entityType: Company additionalProperties: false DateLimitRule_2: 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/DateLimitRangeData' rangeTo: allOf: - $ref: '#/components/schemas/DateLimitRangeData' additionalProperties: false EvaluateDataGroupFieldsRequestDtoServiceRequest_2: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateDataGroupFieldsRequestDto_3' description: Request DTO representing object used to evaluate the condition of data group fields additionalProperties: false RelatedDealsDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedDeals: type: - array - 'null' items: $ref: '#/components/schemas/RelatedDealDto_4' additionalProperties: false EvaluateProductRequirementSetsRequestDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EvaluateProductRequirementSetsRequestDto' description: Request DTO representing entity data properties used to evaluate the condition of product requirement set example: entityType: Company additionalProperties: false ValidationRuleDto_2: 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_2' description: Validation Data - set of validation rules specific to requirement/data group field additionalProperties: false description: Request DTO representing validation rule metadata 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_2' 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_2' 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_2' 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_2' 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_2' description: Validation Rule validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto_2' description: Requirement validation rules V2 conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto_2' 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_2' 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_2' 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_4: type: object properties: dataSource: type: - string - 'null' readOnly: true eventType: type: - string - 'null' eventSubtype: type: - string - 'null' additionalProperties: false EmptyRuleDtoConditionalValueDto_2: 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_2' value: allOf: - $ref: '#/components/schemas/EmptyRuleDto_2' priority: type: integer format: int32 additionalProperties: false RelatedPartiesDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true relatedParties: type: - array - 'null' items: $ref: '#/components/schemas/RelatedPartyDto_4' additionalProperties: false EvaluateProductRequirementSetsResponseDto: type: object properties: requirementSetId: type: string description: The UiD of matched product requirement set format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Name of matched product requirement set example: Fenergo Comprehensive Standard Product Requirements jurisdiction: type: - string - 'null' description: Jurisdiction of matched product requirement set example: Global additionalProperties: false description: Response DTO representing parameters of matched product requirement set ServiceResponseMessage_2: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AlertAssessmentDataSource_5: type: object properties: dataSource: type: - string - 'null' readOnly: true assessments: type: - array - 'null' items: $ref: '#/components/schemas/AlertAssessmentDto_4' lastAssessment: allOf: - $ref: '#/components/schemas/AlertAssessmentDto_4' lastAssessmentOutcome: type: - string - 'null' additionalProperties: false ExternalProviderRuleDto2_2: type: object properties: providerId: type: string format: uuid additionalProperties: false ConditionalValueDto_2: 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_2' value: type: - string - 'null' priority: type: integer format: int32 valueId: type: - string - 'null' additionalProperties: false SpecialCharactersRuleDto2_2: type: object properties: errorMessage: type: - string - 'null' excludedCharacters: type: - array - 'null' items: type: string additionalProperties: false EvaluateProductRequirementSetsRequestDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' description: Entity data properties for condition evaluation dataSources: allOf: - $ref: '#/components/schemas/DataSourcesDto_2' description: Additional data sources used for evaluation cutOffDate: type: - string - 'null' format: date-time additionalProperties: false description: Request DTO representing entity data properties used to evaluate the condition of product requirement set example: entityType: Company ValueLimitRuleDtoValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto2_2' additionalProperties: false CurrentJourneysDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true inProgressJourneyTypes: type: - array - 'null' items: type: string additionalProperties: false ProductRequirementDtoListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ProductRequirementDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false EmptyRuleDtoConditionalValidationRuleDto_2: type: object properties: isActive: type: boolean staticRule: allOf: - $ref: '#/components/schemas/EmptyRuleDto_2' dynamicRules: type: - array - 'null' items: $ref: '#/components/schemas/EmptyRuleDtoConditionalValueDto_2' additionalProperties: false CollectionMaximumCountRuleDto2_2: 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_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ManualCreditAssessmentV2DataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true creditAssessments: type: - array - 'null' items: $ref: '#/components/schemas/CreditAssessmentDto_4' additionalProperties: false ValueLimitRuleDto_2: 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_4: type: object properties: category: type: - string - 'null' additionalProperties: false AccountRelatedFundDto_4: type: object properties: properties: allOf: - $ref: '#/components/schemas/PropertiesDto' additionalProperties: false ReviewAndApprovalDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true reviewAndApprovals: type: - array - 'null' items: $ref: '#/components/schemas/ReviewAndApprovalDto_4' additionalProperties: false DataGroupFieldDto_2: type: object properties: identifier: type: string description: The UiD of the data group field format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Data group field name example: Product Type type: type: - string - 'null' description: Data group field type example: DataGroup order: type: - number - 'null' description: Data group field order format: double example: 2 dataField: allOf: - $ref: '#/components/schemas/DataFieldDto_2' description: Data group field data field isSensitiveData: type: boolean description: Data group field sensitive data flag example: true isCoreDefinition: type: boolean description: Data group field core definition flag example: true validationRule: allOf: - $ref: '#/components/schemas/ValidationRule' description: Data group field validation data validationRulesV2: allOf: - $ref: '#/components/schemas/DataValidationRulesDto_2' description: Data group field validation rules V2 conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' description: Data group field conditions list version: type: integer description: Version number for given Aggregate (concurrency check) format: int32 example: 1 defaultValue: type: - string - 'null' description: Default value for this data field example: Australia isReadOnly: type: boolean description: Is requirement readonly example: false conditionalValues: type: - array - 'null' items: $ref: '#/components/schemas/ConditionalValueDto_2' description: List of conditional values hasEvaluatedConditionalValue: type: boolean description: Does this field has evaluated conditional value? evaluatedConditionalValue: type: - string - 'null' description: Evaluated conditional value description: type: - string - 'null' description: Data group field description example: This is the field description additionalProperties: false description: Response DTO representing data group field data CreditAssessmentDto_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' assessmentOutcome: type: - string - 'null' assessmentComment: type: - string - 'null' taskId: type: - string - 'null' taskDataKey: type: - string - 'null' additionalProperties: false CollateralDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true collaterals: type: - array - 'null' items: $ref: '#/components/schemas/CollateralDto_4' additionalProperties: false RelatedDealDto_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' additionalProperties: false RelatedAssociationDto_4: 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_4: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' assessmentOutcome: type: - string - 'null' providerInternalIdentifier: type: - string - 'null' additionalProperties: false RelatedProductsDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true products: type: - array - 'null' items: $ref: '#/components/schemas/RelatedProductDto_4' additionalProperties: false AccountRelatedFundsDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true accountRelatedFunds: type: - array - 'null' items: $ref: '#/components/schemas/AccountRelatedFundDto_4' additionalProperties: false CurrentProductDataSource_4: type: object properties: dataSource: type: - string - 'null' readOnly: true properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/PropertyDto_5' lifecycleStatus: type: - string - 'null' additionalProperties: false CollectionMinimumCountRuleDto_2: 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_4: type: object properties: dataSource: type: - string - 'null' readOnly: true creditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto_4' relatedPartyCreditScreenings: type: - array - 'null' items: $ref: '#/components/schemas/ManualCreditScreeningDto_4' additionalProperties: false ObjectServiceResponse_2: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false StringServiceResponse_2: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage_2' additionalProperties: false FilterConditionDto_2: type: object properties: fieldName: type: - string - 'null' conditions: type: - array - 'null' items: $ref: '#/components/schemas/ConditionDto_2' additionalProperties: false FormulaVariableDto: type: object properties: dataSource: type: - string - 'null' propertyName: type: - string - 'null' filterConditions: type: - array - 'null' items: $ref: '#/components/schemas/FilterConditionDto_2' additionalProperties: false DataValidationRulesDto_2: type: object properties: mandatory: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto_2' specialCharacters: allOf: - $ref: '#/components/schemas/SpecialCharactersRuleDtoValidationRuleDto_2' noNumbers: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' regex: allOf: - $ref: '#/components/schemas/RegexRuleDtoConditionalValidationRuleDto_2' characterLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto_2' numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoValidationRuleDto_2' noFutureDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' noPastDates: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' dateLimit: allOf: - $ref: '#/components/schemas/DateLimitRuleDtoConditionalValidationRuleDto2' description: Validation rule that allows to set date range multiSelectLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDtoConditionalValidationRuleDto_2' collectionMinimumCount: allOf: - $ref: '#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto_2' collectionMaximumCount: allOf: - $ref: '#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto_2' externalProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto_2' externalDataGroupProvider: allOf: - $ref: '#/components/schemas/ExternalProviderRuleDtoValidationRuleDto_2' readOnly: allOf: - $ref: '#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto_2' conditionalLimit: allOf: - $ref: '#/components/schemas/BasicRuleDtoConditionalValidationRuleDto_2' timeZoneId: type: - string - 'null' disallowTodaysDate: allOf: - $ref: '#/components/schemas/BasicRuleDtoValidationRuleDto_2' 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 x-refined-from: - fenergo-journeylogicengine-v1-0-openapi.json - fenergo-journeylogicengine-v2-0-openapi.json - fenergo-policylogicengine-v1-0-openapi.json - fenergo-policylogicengine-v2-0-openapi.json - fenergo-policylogicengine-v3-0-openapi.json - fenergo-productpolicylogicengine-v1-0-openapi.json