openapi: 3.2.0
info:
  title: Fenergo Nebula CreditScreening Command Manual Credit…
  description: '**CreditScreening Command API**:


    Credit Screening Command API provides both configurational and operational methods related to the client''s credit screenings.'
  version: '1.0'
servers:
- url: /creditscreeningcommand
security:
- Bearer: []
tags:
- name: ManualCreditScreeningBatch
paths:
  /api/manual/batch/update:
    put:
      tags:
      - ManualCreditScreeningBatch
      summary: Update a batch of manual credit screening version
      description: 'This method updates a batch of existing Manual Credit Screening Version.


        Only Manual Credit Screening Version with "Draft" status can be updated.


        Required permissions:

        Following permissions are required: ManualCreditScreeningEdit'
      operationId: UpdateBatch
      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: Batch of Manual Credit Screening Version data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManualCreditScreeningVersionDtoIEnumerableServiceRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ManualCreditScreeningVersionDtoIEnumerableServiceRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ManualCreditScreeningVersionDtoIEnumerableServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BatchResultDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResultDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BatchResultDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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. Manual Credit Screening 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: OBSOLETE_ENDPOINT
  /api/manual/batch/complete:
    put:
      tags:
      - ManualCreditScreeningBatch
      summary: Complete a batch of manual credit screening version
      description: 'This method completes a batch of existing Manual Credit Screening Version.


        Only Manual Credit Screening Version with "Draft" status can be updated.


        Required permissions:

        Following permissions are required: ManualCreditScreeningEdit'
      operationId: CompleteBatch
      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: Batch of Manual Credit Screening Version data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCompleteDtoServiceRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/BatchCompleteDtoServiceRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/BatchCompleteDtoServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BatchResultDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/BatchResultDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BatchResultDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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. Manual Credit Screening 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: OBSOLETE_ENDPOINT
  /api/manual/batch/snapshot:
    post:
      tags:
      - ManualCreditScreeningBatch
      summary: Take a batch of snapshot for manual credit screening version
      description: 'This method takes a batch of snapshot for existing Manual Credit Screening Version.


        Required permissions:

        Following permissions are required: ManualCreditScreeningEdit'
      operationId: BatchSnapshot
      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: Batch of Manual Credit Screening Version data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotSetIEnumerableServiceRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/SnapshotSetIEnumerableServiceRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/SnapshotSetIEnumerableServiceRequest'
      responses:
        '202':
          description: Accepted for processing
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/BatchSnapshotResultDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/BatchSnapshotResultDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/BatchSnapshotResultDtoServiceResponse'
        '400':
          description: Invalid request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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. Manual Credit Screening 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: OBSOLETE_ENDPOINT
components:
  schemas:
    BatchSnapshotResultDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BatchSnapshotResultDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BasicRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
      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
    SnapshotSetIEnumerableServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SnapshotSet'
      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
    SpecialCharactersRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        excludedCharacters:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    BatchResultDto:
      type: object
      properties:
        versions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningVersionDto'
          description: List of versions that updated sucessfully
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BatchErrorDto'
          description: List of errors message schema
      additionalProperties: false
    CompleteDto:
      type: object
      properties:
        setId:
          type: string
          description: Id of the manual credit screening
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        versionNumber:
          type: integer
          description: Version Number of the manual credit screening
          format: int32
          example: 1
      additionalProperties: false
    ManualCreditScreeningItemDto:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        valueTypes:
          type:
          - string
          - 'null'
        separator:
          type:
          - string
          - 'null'
      additionalProperties: false
    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
    ManualCreditScreeningGroupDto:
      type: object
      properties:
        itemsSets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningItemSetDto'
      additionalProperties: false
    RegexRuleDto:
      type: object
      properties:
        active:
          type: boolean
        message:
          type:
          - string
          - 'null'
        isCaseSensitive:
          type: boolean
        regexValue:
          type:
          - string
          - 'null'
      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
    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
    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
    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
    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
    BatchCompleteDto:
      type: object
      properties:
        requests:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CompleteDto'
          description: List of the manual credit screening that needs to be completed
        approver:
          $ref: '#/components/schemas/CreditApprover'
      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
    CreditApprover:
      type: object
      properties:
        id:
          type: string
          format: uuid
        role:
          type:
          - string
          - 'null'
      additionalProperties: false
    BatchErrorDto:
      type: object
      properties:
        setId:
          type: string
          description: Id of the manual credit screening that fails
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
        versionNumber:
          type: integer
          description: Version Number of the manual credit screening that fails
          format: int32
          example: 1
        error:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of service response message
      additionalProperties: false
    SnapshotSet:
      type: object
      properties:
        setId:
          type: string
          format: uuid
        tenantId:
          type: string
          format: uuid
        versionNumber:
          type: integer
          format: int32
        snapshotGroups:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GroupRequirement'
        screeningOutcome:
          $ref: '#/components/schemas/Requirement'
      additionalProperties: false
    ManualCreditScreeningItemSetDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningItemDto'
      additionalProperties: false
    BatchCompleteDtoServiceRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BatchCompleteDto'
      additionalProperties: false
    BatchSnapshotResultDto:
      type: object
      properties:
        snapshotSets:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SnapshotSet'
          description: List of Snapshot Set that updated successfully
        errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BatchErrorDto'
          description: List of errors message schema
      additionalProperties: false
    ManualCreditScreeningVersionDtoIEnumerableServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningVersionDto'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    BatchResultDtoServiceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BatchResultDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ManualCreditScreeningVersionDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the Manual Credit Screening Version
          format: uuid
          example: a4309731-77df-4e72-98e7-0d314b7a5151
        versionNumber:
          type: integer
          description: Version Number of the Manual Credit Screening Version
          format: int32
          example: 1
        setId:
          type: string
          description: Manual Credit Screening Set GUiD
          format: uuid
          example: a4309731-77df-4e72-98e7-0d314b7a5151
        status:
          type:
          - string
          - 'null'
          description: Manual Credit Screening Status
          example: Draft
        screeningOutcome:
          type:
          - string
          - 'null'
          description: The outcome of a screening version.
          example: Adverse Finding
        manualCreditScreeningGroups:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/ManualCreditScreeningGroupDto'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        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
    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
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header