openapi: 3.2.0
info:
  title: Fenergo Nebula Risk Query Risk Assessment API
  description: '**Risk Query API**:


    Risk Query API provides endpoints in order to retrieve all configured risk related models and their versions, as well as to perform risk assessment calculations.


    **Risk Query API provides**:


    Risk Assessment Calculation


    Risk Calculator Scoping Rules retrieval


    Risk Configuration Collection and Items retrieval


    Risk Models retrieval


    Risk Threshold Models retrieval


    Risk Scoping Rules retrieval'
  version: '1.0'
servers:
- url: /riskquery
security:
- Bearer: []
tags:
- name: Risk Assessment
paths:
  /api/risk-assessment:
    post:
      tags:
      - Risk Assessment
      summary: Generate a new Risk Assessment
      description: 'This method will calculate the risk and generate a risk assessment based

        on the options and data defined in the request DTO.


        Required permissions:

        Following permissions are required: RiskCalculatorAccess'
      operationId: RiskAssessment
      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: The Fenergo.Nebula.Risk.Query.Application.Dto.RiskAssessmentDto model defining the risk data for the assessment
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RiskAssessmentDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RiskAssessmentDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RiskAssessmentDtoServiceRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityRiskAssessmentServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityRiskAssessmentServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityRiskAssessmentServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: An exception occurred while processing the command
        '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
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/risk-assessment/{taskId}:
    get:
      tags:
      - Risk Assessment
      summary: Get Risk Assessment by task id
      description: 'This method will retrieve risk assessment by assigned task id .


        Required permissions:

        Following permissions are required: RiskCalculatorAccess'
      operationId: GetRiskAssessmentByTaskId
      parameters:
      - name: taskId
        in: path
        description: Id of the task for returning risk assessment
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
  /api/risk-assessment/taskResults:
    post:
      tags:
      - Risk Assessment
      summary: Get multiple Risk Assessments
      description: 'This method will retrieve risk assessments for provided taskIds


        Required permissions:

        Following permissions are required: RiskCalculatorAccess'
      operationId: GetRiskAssessments
      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: The Fenergo.Nebula.Risk.Query.Application.Dto.RiskAssessmentsRequest consist the collection of taskIds that we want to fetch risk assessements for
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RiskAssessmentsRequestServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RiskAssessmentsRequestServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RiskAssessmentsRequestServiceRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelIEnumerableServiceResponse'
        '400':
          description: Bad Request
          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
  /api/risk-assessment/related-parties/{taskId}:
    post:
      tags:
      - Risk Assessment
      summary: Get Risk Assessments for Related Parties by task id and entity ids
      description: 'This method will retrieve risk assessments for related parties based on the given task id and entity ids.


        Required permissions:

        Following permissions are required: RiskCalculatorAccess'
      operationId: GetRiskAssessmentsForRelatedParties
      parameters:
      - name: taskId
        in: path
        description: Id of the task for returning related parties risk assessments
        required: true
        schema:
          type: string
          format: uuid
      - 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: Ids of the entity for returning related party risk assessment
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetRiskRelatedPartiesResultRequestDtoServiceRequest'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetRiskRelatedPartiesResultRequestDtoServiceRequest'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetRiskRelatedPartiesResultRequestDtoServiceRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelListDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelListDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelListDtoServiceResponse'
        '400':
          description: Bad Request
          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
  /api/risk-assessment/related-parties/{taskId}/entity/{entityId}:
    get:
      tags:
      - Risk Assessment
      summary: Get Risk Assessment for Related Party by task id and entity id
      description: 'This method will retrieve a specific risk assessment for a related party based on the given task id and entity id.


        Required permissions:

        Following permissions are required: RiskCalculatorAccess'
      operationId: GetRiskAssessmentDetailsForRelatedParty
      parameters:
      - name: taskId
        in: path
        description: Id of the task for returning related party risk assessment
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Id of the entity for returning related party risk assessment
        required: true
        schema:
          type: string
          format: uuid
      - 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
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelViewModelDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelViewModelDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RiskTaskResultModelViewModelDtoServiceResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
components:
  schemas:
    ThresholdViewModelDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Display name of the threshold
          example: Low
        minimumValue:
          type:
          - number
          - 'null'
          description: Minimum value of the threshold range
          format: double
          example: 1
        maximumValue:
          type:
          - number
          - 'null'
          description: Maximum value of the threshold range
          format: double
          example: 1.999
        nextReviewPeriod:
          type:
          - integer
          - 'null'
          description: The period in months for the next review of the client
          format: int32
          example: 1
        thresholdColor:
          type:
          - string
          - 'null'
          description: 'Optional UI color assigned to this threshold range for visualization purposes.

            Must be a valid hex value in the form #RRGGBB.'
          example: '#FF0000'
      additionalProperties: false
      description: Represents a threshold used in risk assessment
    RiskFactorGroupRiskAssessmentViewModelDto:
      type: object
      properties:
        riskFactorGroupName:
          type:
          - string
          - 'null'
          description: Name of the risk factor group
          example: Financial Risk
        riskRating:
          type:
          - number
          - 'null'
          description: Risk rating for the group
          format: double
          example: 3
        riskCategory:
          type:
          - string
          - 'null'
          description: Risk category for the group
          example: High
        riskThresholdColor:
          type:
          - string
          - 'null'
          description: Optional hex color code for UI visualization purposes
          example: '#FF0000'
        weight:
          type:
          - number
          - 'null'
          description: Weight of the risk factor group
          format: double
          example: 0.5
        weightedRiskRating:
          type:
          - number
          - 'null'
          description: Weighted risk rating for the group
          format: double
          example: 1.5
        calculationAlgorithm:
          type:
          - string
          - 'null'
          description: Algorithm used for calculation
          example: Average
        calculatedRiskFactorName:
          type:
          - string
          - 'null'
          description: Name of the calculated risk factor
          example: Calculated Financial Risk
        riskFactorAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorRiskAssessmentViewModelDto'
          description: List of individual risk factor assessments
        thresholds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ThresholdViewModelDto'
          description: Thresholds used for this risk factor group assessment
      additionalProperties: false
      description: Represents a risk factor group assessment
    RiskTaskResultModelIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskTaskResultModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AggregateRiskAssessmentViewModelDto:
      type: object
      properties:
        aggregateId:
          type: string
          description: Unique identifier of the aggregate
          format: uuid
          example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b
        entityRiskRating:
          type: number
          description: The overall risk rating for the entity
          format: double
          example: 2.5
        entityRiskCategory:
          type:
          - string
          - 'null'
          description: The risk category for the entity
          example: Medium
        entityRiskThresholdColor:
          type:
          - string
          - 'null'
          description: Optional hex color code for UI visualization purposes.
          example: '#FF0000'
        riskFactorGroupAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorGroupRiskAssessmentViewModelDto'
          description: List of risk factor group assessments
        riskModelName:
          type:
          - string
          - 'null'
          description: Name of the risk model used
          example: Global Risk Model
        riskModelVersion:
          type:
          - integer
          - 'null'
          description: Version of the risk model used
          format: int32
          example: 1
        riskConfigurationModelName:
          type:
          - string
          - 'null'
          description: Name of the risk configuration model used
          example: Global Configuration Model
        riskConfigurationModelVersion:
          type:
          - integer
          - 'null'
          description: Version of the risk configuration model used
          format: int32
          example: 2
        thresholdModelName:
          type:
          - string
          - 'null'
          description: Name of the threshold model used
          example: Global Threshold Model
        thresholdModelVersion:
          type:
          - integer
          - 'null'
          description: Version of the threshold model used
          format: int32
          example: 1
      additionalProperties: false
      description: Represents an aggregate risk assessment
    InputValueRiskAssessment:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        riskCategory:
          type:
          - string
          - 'null'
        riskThresholdColor:
          type:
          - string
          - 'null'
        riskRating:
          type:
          - number
          - 'null'
          format: double
        weight:
          type:
          - number
          - 'null'
          format: double
        weightedRiskRating:
          type:
          - number
          - 'null'
          format: double
      additionalProperties: false
    RiskAssessmentsRequestServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskAssessmentsRequest'
          description: Risk assessments request
      additionalProperties: false
    AggregateRiskAssessmentErrorViewModelDto:
      type: object
      properties:
        aggregateId:
          type: string
          description: Unique identifier of the aggregate
          format: uuid
          example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b
        riskModelId:
          type:
          - string
          - 'null'
          description: Unique identifier of the risk model
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        riskModelVersionNumber:
          type:
          - integer
          - 'null'
          description: Version number of the risk model
          format: int32
          example: 1
        riskConfigurationModelId:
          type:
          - string
          - 'null'
          description: Unique identifier of the risk configuration model
          example: 16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9
        riskConfigurationModelVersionNumber:
          type:
          - integer
          - 'null'
          description: Version number of the risk configuration model
          format: int32
          example: 2
        thresholdModelId:
          type:
          - string
          - 'null'
          description: Unique identifier of the threshold model
          example: a8e4a96e-696a-4d04-89e9-faa74738fc43
        thresholdModelVersionNumber:
          type:
          - integer
          - 'null'
          description: Version number of the threshold model
          format: int32
          example: 1
        message:
          type:
          - string
          - 'null'
          description: Error message describing the assessment failure
          example: Unable to calculate risk due to missing data
      additionalProperties: false
      description: Represents an aggregate risk assessment error
    RiskTaskResultModelListDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskTaskResultModelListDto'
          description: Container for multiple risk assessment overviews for related parties
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    RiskAssessmentsRequest:
      type: object
      properties:
        taskIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of task ids which risk assessments are requested
      additionalProperties: false
      description: Risk assessments request
    RiskTaskResultModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        tenant:
          type:
          - string
          - 'null'
        version:
          type: integer
          format: int32
        isLocked:
          type: boolean
        taskId:
          type: string
          format: uuid
        entityId:
          type:
          - string
          - 'null'
          format: uuid
        entityRiskAssessmentData:
          allOf:
          - $ref: '#/components/schemas/EntityRiskAssessment'
        failedAssessmentData:
          allOf:
          - $ref: '#/components/schemas/RiskAssessmentError'
        aggregateRiskAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregateRiskAssessment'
        failedAggregateAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregateRiskAssessmentError'
        reusedAggregateTaskResults:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregateTaskResultLink'
        excludedAggregateAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExcludedAggregateAssessment'
        runId:
          type:
          - string
          - 'null'
        runStartedAt:
          type: string
          format: date-time
      additionalProperties: false
    OverrideScoresDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Display name of the factor to override
          example: Product Type
        score:
          type: number
          description: The score that the calculated risk level should be overwritten with
          format: double
          example: 5.04
      additionalProperties: false
      description: Risk factor override data
    Threshold:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        minimumValue:
          type:
          - number
          - 'null'
          format: double
        maximumValue:
          type:
          - number
          - 'null'
          format: double
        nextReviewPeriod:
          type:
          - integer
          - 'null'
          format: int32
        thresholdColor:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityRiskAssessmentServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityRiskAssessment'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityRiskAssessment:
      type: object
      properties:
        entityRiskRating:
          type: number
          format: double
        entityRiskCategory:
          type:
          - string
          - 'null'
        entityRiskThresholdColor:
          type:
          - string
          - 'null'
        riskFactorGroupAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorGroupRiskAssessment'
        riskModelName:
          type:
          - string
          - 'null'
        riskModelVersion:
          type:
          - integer
          - 'null'
          format: int32
        riskConfigurationModelName:
          type:
          - string
          - 'null'
        riskConfigurationModelVersion:
          type:
          - integer
          - 'null'
          format: int32
        thresholdModelName:
          type:
          - string
          - 'null'
        thresholdModelVersion:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    RiskFactorRiskAssessment:
      type: object
      properties:
        riskFactorName:
          type:
          - string
          - 'null'
        riskCategory:
          type:
          - string
          - 'null'
        riskThresholdColor:
          type:
          - string
          - 'null'
        riskRating:
          type:
          - number
          - 'null'
          format: double
        weight:
          type:
          - number
          - 'null'
          format: double
        weightedRiskRating:
          type:
          - number
          - 'null'
          format: double
        overrideScore:
          type:
          - number
          - 'null'
          format: double
        calculatedInputValueValue:
          type:
          - string
          - 'null'
        riskLevelCalculationAlgorithm:
          type:
          - string
          - 'null'
        inputValueAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InputValueRiskAssessment'
      additionalProperties: false
    GetRiskRelatedPartiesResultRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetRiskRelatedPartiesResultRequestDto'
      additionalProperties: false
    AggregateTaskResultLink:
      type: object
      properties:
        riskTaskId:
          type: string
          format: uuid
        aggregateId:
          type: string
          format: uuid
        referenceAggregateId:
          type: string
          format: uuid
      additionalProperties: false
    RiskTaskResultModelItemDto:
      type: object
      properties:
        entityId:
          type: string
          description: Unique identifier of the entity being assessed
          format: uuid
          example: 80e92251-db0c-47e0-8e50-490d4bd1db6e
        riskRating:
          type:
          - number
          - 'null'
          description: Risk rating of assessed entity
          format: double
          example: 1
        riskCategory:
          type:
          - string
          - 'null'
          description: Risk category of assessed entity
          example: Low
        riskThresholdColor:
          type:
          - string
          - 'null'
          description: Optional hex color code for UI visualization purposes
          example: '#FF0000'
      additionalProperties: false
      description: Represents the overview of a risk task assessment
    AggregateTaskResultLinkViewModelDto:
      type: object
      properties:
        riskTaskId:
          type: string
          description: Unique identifier of the risk task
          format: uuid
          example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b
        aggregateId:
          type: string
          description: Unique identifier of the aggregate
          format: uuid
          example: 80e92251-db0c-47e0-8e50-490d4bd1db6e
        referenceAggregateId:
          type: string
          description: Unique identifier of the reference aggregate
          format: uuid
          example: 90f82251-db0c-47e0-8e50-490d4bd1db7f
      additionalProperties: false
      description: Represents a link to a reused aggregate task result
    RiskAssessmentErrorViewModelDto:
      type: object
      properties:
        riskModelId:
          type:
          - string
          - 'null'
          description: Unique identifier of the risk model
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        riskModelVersionNumber:
          type:
          - integer
          - 'null'
          description: Version number of the risk model
          format: int32
          example: 1
        riskConfigurationModelId:
          type:
          - string
          - 'null'
          description: Unique identifier of the risk configuration model
          example: 16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9
        riskConfigurationModelVersionNumber:
          type:
          - integer
          - 'null'
          description: Version number of the risk configuration model
          format: int32
          example: 2
        thresholdModelId:
          type:
          - string
          - 'null'
          description: Unique identifier of the threshold model
          example: a8e4a96e-696a-4d04-89e9-faa74738fc43
        thresholdModelVersionNumber:
          type:
          - integer
          - 'null'
          description: Version number of the threshold model
          format: int32
          example: 1
        message:
          type:
          - string
          - 'null'
          description: Error message describing the assessment failure
          example: Unable to calculate risk due to missing data
      additionalProperties: false
      description: Represents a risk assessment error
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AggregateRiskAssessmentError:
      type: object
      properties:
        riskModelId:
          type:
          - string
          - 'null'
        riskModelVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        riskConfigurationModelId:
          type:
          - string
          - 'null'
        riskConfigurationModelVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        thresholdModelId:
          type:
          - string
          - 'null'
        thresholdModelVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        message:
          type:
          - string
          - 'null'
        aggregateId:
          type: string
          format: uuid
      additionalProperties: false
    RiskFactorGroupRiskAssessment:
      type: object
      properties:
        riskFactorGroupName:
          type:
          - string
          - 'null'
        riskRating:
          type:
          - number
          - 'null'
          format: double
        riskCategory:
          type:
          - string
          - 'null'
        riskThresholdColor:
          type:
          - string
          - 'null'
        weight:
          type:
          - number
          - 'null'
          format: double
        weightedRiskRating:
          type:
          - number
          - 'null'
          format: double
        calculationAlgorithm:
          type:
          - string
          - 'null'
        calculatedRiskFactorName:
          type:
          - string
          - 'null'
        riskFactorAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorRiskAssessment'
        thresholds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Threshold'
      additionalProperties: false
    ExcludedAggregateAssessment:
      type: object
      properties:
        aggregateId:
          type: string
          format: uuid
        lifecycleStatus:
          type:
          - string
          - 'null'
      additionalProperties: false
    RiskFactorSelectedAlgorithmDto:
      type: object
      properties:
        factorName:
          type:
          - string
          - 'null'
          description: Display name of the risk factor
          example: Product Type
        riskLevelCalculationAlgorithm:
          type:
          - string
          - 'null'
          description: The selected algorithm to use (min, max, avg, sum)
          example: avg
      additionalProperties: false
      description: "The algorithm to use, for risk level calculation, \nwhen a risk factor has multiple input values"
    RiskTaskResultModelListDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskTaskResultModelItemDto'
          description: Collection of risk assessment overviews for related parties
      additionalProperties: false
      description: Container for multiple risk assessment overviews for related parties
    RiskFactorValueDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Display name of the risk factor
          example: Product Type
        value:
          type:
          - string
          - 'null'
          description: Value of the risk factor
          example: Loan
        weight:
          type:
          - number
          - 'null'
          description: The risk level calculation weight of the factor
          format: double
          example: 1.2
      additionalProperties: false
      description: Risk factor value
    RiskFactorRiskAssessmentViewModelDto:
      type: object
      properties:
        riskFactorName:
          type:
          - string
          - 'null'
          description: Name of the risk factor
          example: Credit Score
        riskCategory:
          type:
          - string
          - 'null'
          description: Risk category for the factor
          example: Low
        riskThresholdColor:
          type:
          - string
          - 'null'
          description: Optional hex color code for UI visualization purposes.
          example: '#FF0000'
        riskRating:
          type:
          - number
          - 'null'
          description: Risk rating for the factor
          format: double
          example: 1
        weight:
          type:
          - number
          - 'null'
          description: Weight of the risk factor
          format: double
          example: 0.3
        weightedRiskRating:
          type:
          - number
          - 'null'
          description: Weighted risk rating for the factor
          format: double
          example: 0.3
        overrideScore:
          type:
          - number
          - 'null'
          description: Manual override score
          format: double
          example: 2
        calculatedInputValueValue:
          type:
          - string
          - 'null'
          description: Calculated input value
          example: '750'
        riskLevelCalculationAlgorithm:
          type:
          - string
          - 'null'
          description: Algorithm used for risk level calculation
          example: Weighted Average
        inputValueAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/InputValueRiskAssessmentViewModelDto'
          description: List of input value assessments
      additionalProperties: false
      description: Represents an individual risk factor assessment
    InputValueRiskAssessmentViewModelDto:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
          description: The input value
          example: '750'
        riskCategory:
          type:
          - string
          - 'null'
          description: Risk category for the input value
          example: Low
        riskThresholdColor:
          type:
          - string
          - 'null'
          description: Optional hex color code for UI visualization purposes
          example: '#FF0000'
        riskRating:
          type:
          - number
          - 'null'
          description: Risk rating for the input value
          format: double
          example: 1
        weight:
          type:
          - number
          - 'null'
          description: Weight of the input value
          format: double
          example: 1
        weightedRiskRating:
          type:
          - number
          - 'null'
          description: Weighted risk rating for the input value
          format: double
          example: 1
      additionalProperties: false
      description: Represents an input value risk assessment
    RiskAssessmentError:
      type: object
      properties:
        riskModelId:
          type:
          - string
          - 'null'
        riskModelVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        riskConfigurationModelId:
          type:
          - string
          - 'null'
        riskConfigurationModelVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        thresholdModelId:
          type:
          - string
          - 'null'
        thresholdModelVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    AggregateRiskAssessment:
      type: object
      properties:
        entityRiskRating:
          type: number
          format: double
        entityRiskCategory:
          type:
          - string
          - 'null'
        entityRiskThresholdColor:
          type:
          - string
          - 'null'
        riskFactorGroupAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorGroupRiskAssessment'
        riskModelName:
          type:
          - string
          - 'null'
        riskModelVersion:
          type:
          - integer
          - 'null'
          format: int32
        riskConfigurationModelName:
          type:
          - string
          - 'null'
        riskConfigurationModelVersion:
          type:
          - integer
          - 'null'
          format: int32
        thresholdModelName:
          type:
          - string
          - 'null'
        thresholdModelVersion:
          type:
          - integer
          - 'null'
          format: int32
        aggregateId:
          type: string
          format: uuid
      additionalProperties: false
    RiskAssessmentDto:
      required:
      - riskConfigurationModelId
      - riskModelId
      - thresholdModelId
      type: object
      properties:
        riskModelId:
          type: string
          description: The UiD of the selected risk model
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        riskModelVersionNumber:
          type:
          - integer
          - 'null'
          description: The version number of the RiskModel to use (optional)
          format: int32
          example: 1
        thresholdModelId:
          type: string
          description: The UiD of the selected threshold model
          format: uuid
          example: a8e4a96e-696a-4d04-89e9-faa74738fc43
        thresholdModelVersionNumber:
          type:
          - integer
          - 'null'
          description: The version number of the ThresholdModel to use (optional)
          format: int32
          example: 4
        riskConfigurationModelId:
          type: string
          description: The UiD of the selected risk configuration model
          format: uuid
          example: 16d3c5e6-2e50-4d55-bcc8-c46d37fa3fb9
        riskConfigurationModelVersionNumber:
          type:
          - integer
          - 'null'
          description: The version number of the RiskConfigurationModel to use (optional)
          format: int32
          example: 1
        inputData:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorValueDto'
          description: A list of risk factor values
        overrideScores:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OverrideScoresDto'
          description: A list of risk factor override scores
        riskFactorSelectedAlgorithms:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorSelectedAlgorithmDto'
          description: A list of selected risk factor calculation algorithms
      additionalProperties: false
      description: Risk assessment generation input data
    RiskTaskResultModelViewModelDto:
      type: object
      properties:
        taskId:
          type: string
          description: Unique identifier of the task
          format: uuid
          example: 0e5a0bae-bd18-474f-8da7-0afcb3eb987b
        entityId:
          type:
          - string
          - 'null'
          description: Unique identifier of the entity being assessed
          format: uuid
          example: 80e92251-db0c-47e0-8e50-490d4bd1db6e
        entityRiskAssessmentData:
          allOf:
          - $ref: '#/components/schemas/EntityRiskAssessmentViewModelDto'
          description: The risk assessment data for the entity
        failedAssessmentData:
          allOf:
          - $ref: '#/components/schemas/RiskAssessmentErrorViewModelDto'
          description: Error data if the assessment failed
        aggregateRiskAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregateRiskAssessmentViewModelDto'
          description: List of aggregate risk assessments
        failedAggregateAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregateRiskAssessmentErrorViewModelDto'
          description: List of failed aggregate assessment errors
        reusedAggregateTaskResults:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AggregateTaskResultLinkViewModelDto'
          description: List of reused aggregate task result links
      additionalProperties: false
      description: Represents the result of a risk task assessment
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    RiskTaskResultModelViewModelDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskTaskResultModelViewModelDto'
          description: Represents the result of a risk task assessment
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    RiskAssessmentDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskAssessmentDto'
          description: Risk assessment generation input data
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityRiskAssessmentViewModelDto:
      type: object
      properties:
        entityRiskRating:
          type: number
          description: The overall risk rating for the entity
          format: double
          example: 2.5
        entityRiskCategory:
          type:
          - string
          - 'null'
          description: The risk category for the entity
          example: Medium
        entityRiskThresholdColor:
          type:
          - string
          - 'null'
          description: Optional hex color code for UI visualization purposes.
          example: '#FF0000'
        riskFactorGroupAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RiskFactorGroupRiskAssessmentViewModelDto'
          description: List of risk factor group assessments
        riskModelName:
          type:
          - string
          - 'null'
          description: Name of the risk model used
          example: Global Risk Model
        riskModelVersion:
          type:
          - integer
          - 'null'
          description: Version of the risk model used
          format: int32
          example: 1
        riskConfigurationModelName:
          type:
          - string
          - 'null'
          description: Name of the risk configuration model used
          example: Global Configuration Model
        riskConfigurationModelVersion:
          type:
          - integer
          - 'null'
          description: Version of the risk configuration model used
          format: int32
          example: 2
        thresholdModelName:
          type:
          - string
          - 'null'
          description: Name of the threshold model used
          example: Global Threshold Model
        thresholdModelVersion:
          type:
          - integer
          - 'null'
          description: Version of the threshold model used
          format: int32
          example: 1
      additionalProperties: false
      description: Represents entity risk assessment data
    RiskTaskResultModelServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RiskTaskResultModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetRiskRelatedPartiesResultRequestDto:
      type: object
      properties:
        entityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header