Fenergo Deal Document Requirement API

openapi: 3.2.0
info:
  title: Fenergo Nebula Document Management Query Deal Document…
  description: Query API to get the documents information to show in the UI.
  version: '1.0'
servers:
- url: /documentmanagementquery
security:
- Bearer: []
tags:
- name: DealDocumentRequirement
paths:
  /api/deal/documentrequirement/{journeyId}:
    get:
      tags:
      - DealDocumentRequirement
      summary: Gets all requirements for a Journey Id
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetAllDealRequirementModelsByJourneyId
      parameters:
      - name: journeyId
        in: path
        description: The journey identifier.
        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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirements if found; \n            otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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: OBSOLETE_ENDPOINT
  /api/deal/documentrequirement/{journeyId}/{requirementId}:
    get:
      tags:
      - DealDocumentRequirement
      summary: Gets a DocumentRequirementModel by Journey Id and Requirement Id
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetDealDocumentRequirementModelByJourneyIdAndRequirementId
      parameters:
      - name: journeyId
        in: path
        description: The journey identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: requirementId
        in: path
        description: The requirement identifier.
        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: "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \n            otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          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. Document requirement model 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/deal/documentrequirement/journey/{journeyId}/dataKey/{documentDataKey}:
    get:
      tags:
      - DealDocumentRequirement
      summary: Gets a DocumentRequirementModel by Journey Id and DocumentDataKey
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetDealDocumentRequirementModelByJourneyIdandDocumentDataKey
      parameters:
      - name: journeyId
        in: path
        description: The journey identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: documentDataKey
        in: path
        description: The requirement identifier defined in policy configuration.
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: "A Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement if found; \n            otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          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. Document requirement model with given id and datakey 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/deal/documentrequirement/deal/{dealId}/journey/{journeyId}:
    get:
      tags:
      - DealDocumentRequirement
      summary: Gets all Document Requirement Statuses for an Deal Id and Journey Id
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetAllRequirementModelsByDealIdAndJourneyId
      parameters:
      - name: dealId
        in: path
        description: The deal identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: journeyId
        in: path
        description: The journey identifier.
        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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \n            otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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: OBSOLETE_ENDPOINT
  /api/deal/documentrequirement/deal/{dealId}:
    get:
      tags:
      - DealDocumentRequirement
      summary: Gets all Document Requirement Statuses for an Deal Id
      description: 'Required permissions:

        Following permissions are required: DocumentManagementAccess'
      operationId: GetAllRequirementModelsByDealId
      parameters:
      - name: dealId
        in: path
        description: The deal identifier.
        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: "A list of the Fenergo.Nebula.DocumentManagement.Query.Application.Dto.DocumentRequirementModelDto class representing the document requirement statuses if found; \n            otherwise, `null`."
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentRequirementModelDtoIEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
            text/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: OBSOLETE_ENDPOINT
components:
  schemas:
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    LinkedDocumentCountDto:
      type: object
      properties:
        overallCount:
          type: integer
          description: Total count of documents linked
          format: int32
        countByType:
          type:
          - object
          - 'null'
          additionalProperties:
            type: integer
            format: int32
          description: Count of documents attached by document type
      additionalProperties: false
    DocumentRequirementModelDto:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the document requirement status
          format: uuid
          example: baee4b61-7ebb-48b2-a44b-18ce814b703b
        requirementId:
          type:
          - string
          - 'null'
          description: The Id of the requirement the document requirement status belongs to
          example: 86581ed9-3ebc-4e7c-b26d-16c1849fa43e
        requirementName:
          type:
          - string
          - 'null'
          description: The Name of the document requirement defined in policy configuration
          example: Driver License
        documentDataKey:
          type:
          - string
          - 'null'
          description: The unique identifier of the document requirement defined in policy configuration
          example: identificationDocuments
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the journey the document requirement belongs to
          example: 742ac1df-1296-4620-aa44-a34e09e859f4
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the entity the document requirement status belongs to
          example: 742ac1df-1296-4620-aa44-a34e09e859f4
        isMandatory:
          type: boolean
          description: IsMandatory attribute of the document requirement defined in policy configuration
          example: false
        targetEntity:
          type:
          - string
          - 'null'
          description: The target entity of the requirement
          example: Client
        history:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentRequirementHistoryDto'
          description: The history of the requirement containing all updates to the status
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Document requirement access layers
        hasRequiredAccessLayers:
          type: boolean
          description: 'Flag indicating if current user has required access layers to access document requirement model

            If false, the sensitive properties with be masked by replacing with null or empty values'
        linkedDocumentCount:
          allOf:
          - $ref: '#/components/schemas/LinkedDocumentCountDto'
          description: Overall count and count by type of documents uploaded against this requirement
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/DocumentRequirementProperty'
          description: Custom document requirement properties
      additionalProperties: false
      description: Document Requirement data
    AccessLayerDto:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
          example:
          - Global
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
          example:
          - Enterprise
      additionalProperties: false
      description: DTO representing access layers attached
    DocumentRequirementProperty:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    DocumentRequirementHistoryDto:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          description: The Status of the Document Requirement
          example: Approved
        lastUpdated:
          type: string
          description: The date that the Document Requirement was last updated
          format: date-time
        comment:
          type:
          - string
          - 'null'
          description: A comment relating to the Document Requirement Status change
        deferUntil:
          type:
          - string
          - 'null'
          description: The deferral date of the requirement. This is only set if Status is "Defer Requested"
          format: date-time
      additionalProperties: false
      description: Document Requirement History
    DocumentRequirementModelDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/DocumentRequirementModelDto'
          description: Document Requirement 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
    DocumentRequirementModelDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DocumentRequirementModelDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header