openapi: 3.2.0
info:
  title: Fenergo Credit Assessment API
  version: '1.0'
  description: 'Operations tagged CreditAssessment across 2 of this provider''s published API definitions: fenergo-creditassessmentcommand-v1-0-openapi.json, fenergo-creditassessmentquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /creditassessmentcommand
- url: /creditassessmentquery
security:
- Bearer: []
tags:
- name: CreditAssessment
paths:
  /api/creditassessment:
    post:
      tags:
      - CreditAssessment
      summary: Create a Credit Assessment set
      description: 'Creates a new Credit Assessment set which is tied to a specific journey


        Required permissions:

        Following permissions are required: CreditAssessmentEdit'
      operationId: CreateCreditAssessmentSet
      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: ServiceRequest with the Fenergo.Nebula.CreditAssessment.Command.Application.Dto.CreditAssessmentSet.CreditAssessmentSetRequestDto to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditAssessmentSetRequestDtoServiceRequest'
      responses:
        '202':
          description: Success. Credit Assessment set created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentSetResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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: Error Code
    servers:
    - url: /creditassessmentcommand
  /api/creditassessment/{setId}:
    delete:
      tags:
      - CreditAssessment
      summary: Delete a Credit Assessment set and all of its assessments
      description: 'Deletes the specified Credit Assessment set and all its assessments


        Required permissions:

        Following permissions are required: CreditAssessmentDelete'
      operationId: DeleteCreditAssessmentSet
      parameters:
      - name: setId
        in: path
        description: Credit Assessment set to be deleted
        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:
        '202':
          description: Success. Credit Assessment set deleted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The specified Credit Assessment set does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentcommand
  /api/creditassessment/{setId}/assessment:
    post:
      tags:
      - CreditAssessment
      summary: Create a new Credit Assessment
      description: 'This method creates a new Credit Assessment in the selected Set


        Required permissions:

        Following permissions are required: CreditAssessmentEdit'
      operationId: CreateCreditAssessment
      parameters:
      - name: setId
        in: path
        description: Credit Assessment set to create new Credit Assessment in
        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: ServiceRequest with the Fenergo.Nebula.CreditAssessment.Command.Application.Dto.CreditAssessment.CreditAssessmentDto to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditAssessmentDtoServiceRequest'
      responses:
        '202':
          description: Success. Credit Assessment created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The specified Credit Assessment set does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentcommand
  /api/creditassessment/{setId}/assessment/{assessmentId}/version:
    post:
      tags:
      - CreditAssessment
      summary: Create a new Credit Assessment version
      description: 'This method creates a new Credit Assessment version based on the latest existing version


        A new version can only be created if the status of the latest version is completed or rejected


        Required permissions:

        Following permissions are required: CreditAssessmentEdit'
      operationId: CreateNewCreditAssessmentVersion
      parameters:
      - name: setId
        in: path
        description: Credit Assessment set the assessment belongs to
        required: true
        schema:
          type: string
          format: uuid
      - name: assessmentId
        in: path
        description: Credit Assessment to create a new version for
        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:
        '202':
          description: Success. New Credit Assessment version created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentVersionDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The specified Credit Assessment set/assessment does not exist
                  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: Error Code
    put:
      tags:
      - CreditAssessment
      summary: Update an existing Credit Assessment version
      description: 'This method updates a Credit Assessment version


        The Credit Assessment version being updated must be in a draft status


        The version data must be compliant with validation rules.


        Required permissions:

        Following permissions are required: CreditAssessmentEdit'
      operationId: UpdateCreditAssessmentVersion
      parameters:
      - name: setId
        in: path
        description: Credit Assessment set the assessment belongs to
        required: true
        schema:
          type: string
          format: uuid
      - name: assessmentId
        in: path
        description: Credit Assessment set the version belongs to
        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: ServiceRequest with the Fenergo.Nebula.CreditAssessment.Command.Application.Dto.CreditAssessmentVersion.CreditAssessmentVersionDto to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditAssessmentVersionDtoServiceRequest'
      responses:
        '202':
          description: Success. Credit Assessment version updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentVersionDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The specified Credit Assessment set/assessment/version does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentcommand
  /api/creditassessment/{setId}/assessment/{assessmentId}/version/{versionNumber}/complete:
    put:
      tags:
      - CreditAssessment
      summary: Complete an existing Credit Assessment version
      description: 'Required permissions:

        Following permissions are required: CreditAssessmentEdit'
      operationId: CompleteCreditAssessmentVersion
      parameters:
      - name: setId
        in: path
        description: Credit Assessment Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: assessmentId
        in: path
        description: Credit Assessment Id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Credit Assessment Version Number
        required: true
        schema:
          type: integer
          format: int32
      - 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:
        '202':
          description: Success. Credit Assessment version updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertiesValidatorResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The specified Credit Assessment set/assessment/version does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentcommand
  /api/creditassessment/{setId}/assessment/{assessmentId}/version/{versionNumber}/snapshot:
    post:
      tags:
      - CreditAssessment
      summary: Create a manual credit assessment snapshot
      description: 'Required permissions:

        Following permissions are required: CreditAssessmentEdit'
      operationId: CreateCreditAsssessmentSnapshot
      parameters:
      - name: setId
        in: path
        description: Credit Assessment Set Id
        required: true
        schema:
          type: string
          format: uuid
      - name: assessmentId
        in: path
        description: Credit Assessment Id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: Credit Assessment Version Number
        required: true
        schema:
          type: integer
          format: int32
      - 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: Manual Credit Assessment Snapshot data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotSetServiceRequest'
      responses:
        '202':
          description: Success. Credit Assessment version updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotSetServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The specified Credit Assessment assessmentId/version does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentcommand
  /api/creditassessment/set/{setId}:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment Set with all and latest version of credit assessments
      description: 'Returns the Credit Assessment Set for the specified ID


        Required permissions:

        Following permissions are required: CreditAssessmentAccess'
      operationId: GetCreditAssessmentSetById
      parameters:
      - name: setId
        in: path
        description: The id of the Credit Assessment Set to retrieve
        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: Success. Credit Assessment Set is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentSetDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Credit Assessment Set with given id does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentquery
  /api/creditassessment/set/journey/{journeyId}:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment Set with all and latest version of credit assessments…
      description: 'Returns the Credit Assessment Set for the specified Journey ID


        Required permissions:

        Following permissions are required: CreditAssessmentAccess'
      operationId: GetCreditAssessmentSetByJourneyId
      parameters:
      - name: journeyId
        in: path
        description: The Journey Id of the Credit Assessment Set to retrieve
        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: Success. Credit Assessment set is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentSetDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. A Credit Assessment set for the given journey id does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentquery
  /api/creditassessment/assessment/{assessmentId}:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment by Id
      description: 'Returns the Credit Assessment for the specified ID with latest version


        Required permissions:

        Following permissions are required: CreditAssessmentAccess'
      operationId: GetCreditAssessmentById
      parameters:
      - name: assessmentId
        in: path
        description: The id of the Credit Assessment to retrieve
        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: Success. Credit Assessment is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Credit Assessment with given id does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentquery
  /api/creditassessment/assessment/task/{taskId}:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment by Task Id
      description: 'Returns the Credit Assessment for the specified Task ID with latest version


        Required permissions:

        Following permissions are required: CreditAssessmentAccess'
      operationId: GetCreditAssessmentByTaskId
      parameters:
      - name: taskId
        in: path
        description: The corresponding task id of the Credit Assessment to retrieve
        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: Success. Credit Assessment is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditAssessmentDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Credit Assessment for given Task id does not exist
                  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: Error Code
    servers:
    - url: /creditassessmentquery
  /api/creditassessment/assessment/{assessmentId}/version/{versionNumber}/snapshot:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment Snapshot by creditAssessmentId and versionNumber
      description: 'Returns a Credit Assessment Snapshot by creditAssessmentId and versionNumber


        Required permissions:

        Following permissions are required: CreditAssessmentAccess'
      operationId: GetCreditAsssessmentSnapshot
      parameters:
      - name: assessmentId
        in: path
        description: The credit assessment id
        required: true
        schema:
          type: string
          format: uuid
      - name: versionNumber
        in: path
        description: The credit assessment version number
        required: true
        schema:
          type: integer
          format: int32
      - 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: Success. Credit Assessment Snapshot is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotSetServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Credit Assessment Snapshot cannot be 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: Error Code
    servers:
    - url: /creditassessmentquery
  /api/creditassessment/journey/{journeyId}/history:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment History by journeyId
      description: 'Returns a Credit Assessment History by journeyId


        Required permissions:

        Following permissions are required: CreditAssessmentAccess, AutomatedCreditAssessmentAccess'
      operationId: GetHistoryByJourneyId
      parameters:
      - name: journeyId
        in: path
        description: The credit assessment journeyId
        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: Success. History is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoryDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. History cannot be 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: Error Code
    servers:
    - url: /creditassessmentquery
  /api/creditassessment/task/{taskId}/historysnapshot:
    get:
      tags:
      - CreditAssessment
      summary: Get a Credit Assessment History Snapshot by taskId
      description: 'Returns a Credit Assessment History Snapshot by taskId


        Required permissions:

        Following permissions are required: CreditAssessmentAccess, AutomatedCreditAssessmentAccess'
      operationId: GetHistorySnapshotByTaskId
      parameters:
      - name: taskId
        in: path
        description: The credit assessment taskId
        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: Success. History Snapshot is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HistoryDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. History Snapshot cannot be 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: Error Code
    servers:
    - url: /creditassessmentquery
components:
  schemas:
    SpecialCharactersRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        excludedCharacters:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    SnapshotSetServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SnapshotSet'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ExternalProviderRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        providerId:
          type: string
          format: uuid
      additionalProperties: false
    CreditAssessmentSetResponseDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreditAssessmentSetResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PropertyDto:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: The property Type
          example: Single
        discriminator:
          type:
          - string
          - 'null'
          description: The property discriminator
          example: Single
        value:
          type:
          - string
          - 'null'
          description: The property value
          example: Australia
      additionalProperties: false
      description: Defines the metadata type
    CreditAssessmentSetResponseDto:
      type: object
      properties:
        id:
          type: string
          description: Credit Decision Set identifier
          format: uuid
          example: 661cbc05-4a6d-4d08-aaed-a9d334e9ad9c
        journeyId:
          type: string
          description: Journey Id which the Credit Decision set belongs to
          format: uuid
          example: 549bfca3-1cc0-4186-b4c3-751be5fc2ced
        status:
          type:
          - string
          - 'null'
          description: Status of the Credit Decision set
          example: Verified
        creditAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditAssessmentDto'
          description: List of credit assessments
      additionalProperties: false
      description: Response DTO representing Credit Decision set data
    ValidationDataDto:
      type: object
      properties:
        isMandatory:
          $ref: '#/components/schemas/BasicRuleDto'
        specialCharacters:
          $ref: '#/components/schemas/SpecialCharactersRuleDto'
        noNumbers:
          $ref: '#/components/schemas/BasicRuleDto'
        onlyInteger:
          $ref: '#/components/schemas/BasicRuleDto'
        noNegative:
          $ref: '#/components/schemas/BasicRuleDto'
        onlyDecimal:
          $ref: '#/components/schemas/BasicRuleDto'
        regex:
          $ref: '#/components/schemas/RegexRuleDto'
        characterLimit:
          $ref: '#/components/schemas/ValueLimitRuleDto'
        numberLimit:
          $ref: '#/components/schemas/ValueLimitRuleDto'
        noFutureDates:
          $ref: '#/components/schemas/BasicRuleDto'
        noPastDates:
          $ref: '#/components/schemas/BasicRuleDto'
        dateLimit:
          $ref: '#/components/schemas/DateLimitRuleDto'
        multiSelectLimit:
          $ref: '#/components/schemas/ValueLimitRuleDto'
        collectionMinimumCount:
          $ref: '#/components/schemas/CollectionMinimumCountRuleDto'
        collectionMaximumCount:
          $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
        externalProvider:
          $ref: '#/components/schemas/ExternalProviderRuleDto'
      additionalProperties: false
    CreditAssessmentDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreditAssessmentDto'
      additionalProperties: false
    CreditApproverDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Credit Approver identifier
          example: 41e1dfa3-9e93-467d-8fdb-7ae0aecea913
        order:
          type: integer
          description: Number indicating which order the approver will make a decision in
          format: int32
          example: 1
        role:
          type:
          - string
          - 'null'
          description: Role/Team the approver belongs to
          example: Relationship Manager 1
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Credit Approver metadata
      additionalProperties: false
      description: DTO representing Credit Approver data
    CreditAssessmentVersionDto:
      type: object
      properties:
        id:
          type: string
          description: Identifier of the Credit Decision version
          format: uuid
          example: 7f637116-814a-4430-b924-1d56ed024fc3
        versionNumber:
          type: integer
          description: Version number
          format: int32
        status:
          type:
          - string
          - 'null'
          description: Status of the Credit Decision version
          example: Verified
        assessmentOutcome:
          type:
          - string
          - 'null'
          description: Credit approval decision made by the approver
          example: Recommended
        assessmentComment:
          type:
          - string
          - 'null'
          description: Credit approval comment made by the approver
          example: Recommended
        supportingDocuments:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: List of IDs of the documents provided for consideration when determining credit decision
        integrationProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Response from integrated credit providers
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Credit Decision metadata
        groupProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/GroupDto'
          description: Credit Decision for grouped metadata
        approver:
          $ref: '#/components/schemas/CreditApproverDto'
        created:
          type: string
          description: Date and time that the Credit Assessment was created
          format: date-time
          example: '2020-01-01T20:00:00.000Z'
        lastUpdated:
          type: string
          description: Date and time that the Credit Assessment was last updated
          format: date-time
          example: '2021-01-01T22:00:00.000Z'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: Jurisdiction metadata of Credit Assessment
      additionalProperties: false
      description: DTO representing Credit Decision version data
    GroupSetDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupSetItemDto'
          description: A collection of items.
      additionalProperties: false
    PropertiesValidatorResponseServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PropertiesValidatorResponse'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PropertiesValidatorResponse:
      type: object
      properties:
        isValid:
          type: boolean
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/PolicyValidationResponseError'
      additionalProperties: false
    CollectionMaximumCountRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        requiredTypesMaxCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - integer
            - 'null'
            format: int32
        overallMaximumCount:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    ValueLimitRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        minValue:
          type:
          - integer
          - 'null'
          format: int32
        maxValue:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    BasicRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    GroupRequirement:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        key:
          type:
          - string
          - 'null'
        primaryDataGroupField:
          type:
          - string
          - 'null'
        snapshotPropertyItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupRequirementItem'
        validationRule:
          $ref: '#/components/schemas/ValidationRuleDto'
      additionalProperties: false
    CreditAssessmentSetRequestDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreditAssessmentSetRequestDto'
      additionalProperties: false
    GroupSetItemDto:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
          description: The dataKey of the item
        value:
          type:
          - string
          - 'null'
          description: Value of the item
        valueType:
          type:
          - string
          - 'null'
          description: The type of the value of the item.
        separator:
          type:
          - string
          - 'null'
          description: The separator character to be used for grouping multiple values.
      additionalProperties: false
      description: An individual item from a group.
    SnapshotSetServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/SnapshotSet'
      additionalProperties: false
    SnapshotSet:
      type: object
      properties:
        creditAssessmentId:
          type: string
          description: Credit Assessment Id
          format: uuid
          example: cc91d893-7643-433a-9b7c-00813178dc76
        versionNumber:
          type: integer
          description: Version number of the credit assessment
          format: int32
          example: 1
        requirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Requirement'
          description: List of requirements
        assessmentOutcome:
          $ref: '#/components/schemas/Requirement'
        groupRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupRequirement'
          description: List of Group Requirements
      additionalProperties: false
    CreditAssessmentDto:
      type: object
      properties:
        id:
          type: string
          description: Credit Decision identifier
          format: uuid
          example: cc91d893-7643-433a-9b7c-00813178dc76
        setId:
          type: string
          description: Identifier of the Credit Decision set this belongs to
          format: uuid
          example: 78e59d67-9f80-4f5a-b25a-036d603cb37e
        taskId:
          type: string
          description: Identifier of the Credit Decision task
          format: uuid
          example: 53eeadd4-b177-451f-9a78-0311b52b3e72
        taskDataKey:
          type:
          - string
          - 'null'
          description: Task DataKey
          example: ket one
        name:
          type:
          - string
          - 'null'
          description: Name of this credit assessment.
        version:
          $ref: '#/components/schemas/CreditAssessmentVersionDto'
      additionalProperties: false
      description: DTO representing Credit Decision data
    Requirement:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        order:
          type:
          - integer
          - 'null'
          format: int32
        separator:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        validationRule:
          $ref: '#/components/schemas/ValidationRuleDto'
      additionalProperties: false
    GroupRequirementItem:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        valueType:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        isAdditionalField:
          type: boolean
        validationRule:
          $ref: '#/components/schemas/ValidationRuleDto'
      additionalProperties: false
    VersionedJurisdictionDto:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 254428e9-d232-4738-81c9-151409b296a3
      additionalProperties: false
      description: Defines the jurisdiction requirement for the credit assessment
    CollectionMinimumCountRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        requiredTypesMinCount:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - integer
            - 'null'
            format: int32
        overallMinimumCount:
          type: integer
          format: int32
      additionalProperties: false
    ValidationRuleDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        setId:
          type: string
          format: uuid
        propertyId:
          type: string
          format: uuid
        dataGroupId:
          type:
          - string
          - 'null'
          format: uuid
        isDataGroup:
          type: boolean
        propertyName:
          type:
          - string
          - 'null'
        friendlyName:
          type:
          - string
          - 'null'
        validationType:
          type:
          - string
          - 'null'
        validationData:
          $ref: '#/components/schemas/ValidationDataDto'
      additionalProperties: false
    DateLimitRuleDto:
      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
    CreditAssessmentVersionDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreditAssessmentVersionDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreditAssessmentDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreditAssessmentDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    PolicyValidationResponseError:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        propertyValue:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreditAssessmentSetRequestDto:
      type: object
      properties:
        journeyId:
          type: string
          description: Journey Id which the Credit Decision set belongs to
          format: uuid
          example: 549bfca3-1cc0-4186-b4c3-751be5fc2ced
        creditAssessment:
          $ref: '#/components/schemas/CreditAssessmentRequestDto'
      additionalProperties: false
      description: Request DTO representing Credit Decision set data
    CreditAssessmentRequestDto:
      type: object
      properties:
        taskId:
          type: string
          description: Identifier of the Credit Decision task
          format: uuid
          example: 53eeadd4-b177-451f-9a78-0311b52b3e72
        name:
          type:
          - string
          - 'null'
          description: Name of this Credit Assessment
          example: Credit Assessment Name
        taskDataKey:
          type:
          - string
          - 'null'
          description: Task DataKey
          example: Key One
        version:
          $ref: '#/components/schemas/CreditAssessmentVersionDto'
      additionalProperties: false
      description: Request DTO containing Credit Decision data for use when creating a new set
    CreditAssessmentVersionDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreditAssessmentVersionDto'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    RegexRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        isCaseSensitive:
          type: boolean
        regexValue:
          type:
          - string
          - 'null'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    GroupDto:
      type: object
      properties:
        sets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupSetDto'
          description: A collection of sets of items to be used for grouped data.
      additionalProperties: false
    HistoryVersionDto:
      type: object
      properties:
        assessmentId:
          type:
          - string
          - 'null'
          description: The Id of the credit assessment
        taskName:
          type:
          - string
          - 'null'
          description: The name of the credit assessment task
        versionNumber:
          type: integer
          description: The version number / order of the credit assessment
          format: int32
        assessmentOutcome:
          type:
          - string
          - 'null'
          description: The assessment outcome for the credit assessment
        assessmentComment:
          type:
          - string
          - 'null'
          description: The assessment comment for the credit assessment
        type:
          type:
          - string
          - 'null'
          description: The credit assessment type. "Automated" or "Manual"
        completedOn:
          type:
          - string
          - 'null'
          description: The datetime the credit assessment was completed on
          format: date-time
        approverRole:
          type:
          - string
          - 'null'
          description: The role of the credit assessment approver. For Automated credit assessments this will be "System"
        approverId:
          type:
          - string
          - 'null'
          description: The Id of the approver of the task. Only for manual credit assessment
        providerName:
          type:
          - string
          - 'null'
          description: The name of the provider the assessment data was obtained from. Only for automated credit assessment
      additionalProperties: false
    SnapshotSetServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SnapshotSet_2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    HistoryDto:
      type: object
      properties:
        historyItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/HistoryItemDto'
          description: A list of all history items for a given criteria. To represent automated and manual credit assessments.
      additionalProperties: false
    HistoryDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/HistoryDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationDataDto_2:
      type: object
      properties:
        isMandatory:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        specialCharacters:
          allOf:
          - $ref: '#/components/schemas/SpecialCharactersRuleDto'
        noNumbers:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        onlyInteger:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        noNegative:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        onlyDecimal:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        regex:
          allOf:
          - $ref: '#/components/schemas/RegexRuleDto'
        characterLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
        numberLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
        noFutureDates:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        noPastDates:
          allOf:
          - $ref: '#/components/schemas/BasicRuleDto'
        dateLimit:
          allOf:
          - $ref: '#/components/schemas/DateLimitRuleDto'
        multiSelectLimit:
          allOf:
          - $ref: '#/components/schemas/ValueLimitRuleDto'
        collectionMinimumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMinimumCountRuleDto'
        collectionMaximumCount:
          allOf:
          - $ref: '#/components/schemas/CollectionMaximumCountRuleDto'
        externalProvider:
          allOf:
          - $ref: '#/components/schemas/ExternalProviderRuleDto'
      additionalProperties: false
    CreditAssessmentVersionDto_2:
      type: object
      properties:
        id:
          type: string
          description: Identifier of the Credit Assessment version
          format: uuid
          example: 7f637116-814a-4430-b924-1d56ed024fc3
        versionNumber:
          type: integer
          description: Version number of the credit assessment
          format: int32
        status:
          type:
          - string
          - 'null'
          description: Status of the Credit Assessment version
          example: Verified
        assessmentOutcome:
          type:
          - string
          - 'null'
          description: Credit approval decision made by the approver
          example: Recommended
        assessmentComment:
          type:
          - string
          - 'null'
          description: Credit approval decision made by the approver
          example: Recommended
        supportingDocuments:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: List of IDs of the documents provided for consideration when determining credit assessment
        integrationProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Response from integrated credit providers
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Credit Assessment metadata
        groupProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/GroupDto'
          description: Credit Decision for grouped metadata
        approver:
          allOf:
          - $ref: '#/components/schemas/CreditApproverDto'
          description: Approver chosen to review this credit assessment
        created:
          type: string
          description: Date and time that the Credit Assessment was created
          format: date-time
          example: '2020-01-01T20:00:00.000Z'
        lastUpdated:
          type: string
          description: Date and time that the Credit Assessment was last updated
          format: date-time
          example: '2021-01-01T22:00:00.000Z'
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: Jurisdictions for entity
      additionalProperties: false
      description: DTO representing Credit Assessment version data
    GroupRequirement_2:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        key:
          type:
          - string
          - 'null'
        primaryDataGroupField:
          type:
          - string
          - 'null'
        snapshotPropertyItems:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupRequirementItem_2'
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
      additionalProperties: false
    SnapshotSet_2:
      type: object
      properties:
        creditAssessmentId:
          type: string
          description: Credit Assessment Id
          format: uuid
          example: cc91d893-7643-433a-9b7c-00813178dc76
        versionNumber:
          type: integer
          description: Version number of the credit assessment
          format: int32
          example: 1
        requirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Requirement_2'
          description: List of requirements
        assessmentOutcome:
          allOf:
          - $ref: '#/components/schemas/Requirement_2'
          description: Rquirements for assessment outcome
        groupRequirements:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupRequirement_2'
          description: List of Group Requirements
      additionalProperties: false
    CreditAssessmentDto_2:
      type: object
      properties:
        id:
          type: string
          description: Credit Decision identifier
          format: uuid
          example: cc91d893-7643-433a-9b7c-00813178dc76
        setId:
          type: string
          description: Identifier of the set this Credit Decision belongs to
          format: uuid
          example: 78e59d67-9f80-4f5a-b25a-036d603cb37e
        taskId:
          type: string
          description: Identifier of the Credit Decision task
          format: uuid
          example: 53eeadd4-b177-451f-9a78-0311b52b3e72
        taskDataKey:
          type:
          - string
          - 'null'
          description: Task DataKey
          example: ket one
        name:
          type:
          - string
          - 'null'
          description: Name of this Credit Assessment
          example: Name
        version:
          allOf:
          - $ref: '#/components/schemas/CreditAssessmentVersionDto_2'
          description: Request DTO containing latest credit decision version data
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditAssessmentVersionDto_2'
          description: All versions for the current credit assessment
      additionalProperties: false
      description: DTO representing Credit Decision data
    Requirement_2:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        order:
          type:
          - integer
          - 'null'
          format: int32
        separator:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
      additionalProperties: false
    CreditAssessmentSetDto:
      type: object
      properties:
        id:
          type: string
          description: Credit Decision Set identifier
          format: uuid
          example: 661cbc05-4a6d-4d08-aaed-a9d334e9ad9c
        journeyId:
          type: string
          description: Journey Id which the Credit Decision set belongs to
          format: uuid
          example: 549bfca3-1cc0-4186-b4c3-751be5fc2ced
        status:
          type:
          - string
          - 'null'
          description: Status of the Credit Decision set
          example: Verified
        created:
          type: string
          description: Date and time that the set was created
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        creditAssessments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreditAssessmentDto_2'
          description: List of Credit Decisions in set
      additionalProperties: false
      description: DTO representing Credit Decision set data
    GroupRequirementItem_2:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        valueType:
          type:
          - string
          - 'null'
        order:
          type: integer
          format: int32
        isAdditionalField:
          type: boolean
        validationRule:
          allOf:
          - $ref: '#/components/schemas/ValidationRuleDto_2'
      additionalProperties: false
    ValidationRuleDto_2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        setId:
          type: string
          format: uuid
        propertyId:
          type: string
          format: uuid
        dataGroupId:
          type:
          - string
          - 'null'
          format: uuid
        isDataGroup:
          type: boolean
        propertyName:
          type:
          - string
          - 'null'
        friendlyName:
          type:
          - string
          - 'null'
        validationType:
          type:
          - string
          - 'null'
        validationData:
          allOf:
          - $ref: '#/components/schemas/ValidationDataDto_2'
      additionalProperties: false
    CreditAssessmentDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreditAssessmentDto_2'
          description: DTO representing Credit Decision data
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    HistoryItemDto:
      type: object
      properties:
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/HistoryVersionDto'
          description: All versions for a given credit assessment.
      additionalProperties: false
    CreditAssessmentSetDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreditAssessmentSetDto'
          description: DTO representing Credit Decision set data
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-creditassessmentcommand-v1-0-openapi.json
- fenergo-creditassessmentquery-v1-0-openapi.json