Fenergo Idv Business Process API

openapi: 3.2.0
info:
  title: Fenergo Idv Business Process API
  version: '1.0'
  description: 'Operations tagged IdvBusinessProcess across 4 of this provider''s published API definitions: fenergo-digitalidvcommand-v1-0-openapi.json, fenergo-digitalidvcommand-v2-0-openapi.json, fenergo-digitalidvquery-v1-0-openapi.json, fenergo-digitalidvquery-v2-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /digitalidvcommand
- url: /digitalidvquery
security:
- Bearer: []
tags:
- name: IdvBusinessProcess
paths:
  /api/idv-business-process:
    post:
      tags:
      - IdvBusinessProcess
      summary: Initiate an Idv requirements validation business process
      description: 'Idv requirements validation business process initialization


        Required permissions:

        Following permissions are required: IdvAccess'
      operationId: InitiateIdvRequirementsValidation
      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.DigitalIDV.Command.Application.Dto.IdvRequirementsValidation.InitiateIdvRequirementsValidationDto to initiate business process
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Idv requirements validation business process initiated successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /digitalidvcommand
  /api/v2/idv-business-process:
    post:
      tags:
      - IdvBusinessProcess
      summary: Initiate an Idv requirements validation business process
      description: 'Idv requirements validation business process initialization


        Required permissions:

        Following permissions are required: IdvAccess'
      operationId: InitiateIdvRequirementsValidation
      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.DigitalIDV.Command.Application.Dto.IdvRequirementsValidation.InitiateIdvRequirementsValidationDto to initiate business process
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: Idv requirements validation business process initiated successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /digitalidvcommand
  /api/idv-business-process/{businessProcessId}:
    get:
      tags:
      - IdvBusinessProcess
      summary: Get an Idv requirements validation business process
      description: 'Get the Idv requirements validation business process by id


        Required permissions:

        Following permissions are required: IdvAccess'
      operationId: GetIdvRequirementsValidationBusinessProcess
      parameters:
      - name: businessProcessId
        in: path
        description: ''
        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: Idv requirements validation business process retrieved successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Business process with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /digitalidvquery
  /api/v2/idv-business-process/{businessProcessId}:
    get:
      tags:
      - IdvBusinessProcess
      summary: Get an Idv requirements validation business process
      description: 'Get the Idv requirements validation business process by id


        Required permissions:

        Following permissions are required: IdvAccess'
      operationId: GetIdvRequirementsValidationBusinessProcess
      parameters:
      - name: businessProcessId
        in: path
        description: ''
        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: Idv requirements validation business process retrieved successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. Business process with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /digitalidvquery
components:
  schemas:
    InitiateIdvRequirementsValidationResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/InitiateIdvRequirementsValidationResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    InitiateIdvRequirementsValidationResponseDto:
      type: object
      properties:
        businessProcessId:
          type: string
          description: The UiD of the initiated Idv requirements validation business process
          format: uuid
          example: 24511767-4586-4b69-af43-c405ec6b154a
      additionalProperties: false
      description: Response DTO representing initiated Idv requirements validation business process response
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ObjectServiceResponse:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    InitiateIdvRequirementsValidationDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/InitiateIdvRequirementsValidationDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    VersionedJurisdictionDto:
      required:
      - jurisdiction
      type: object
      properties:
        jurisdiction:
          minLength: 1
          type: string
          description: Jurisdiction of the requirement
          example: Global
        versionId:
          type:
          - string
          - 'null'
          description: Version of the requirement jurisdiction
          format: uuid
          example: 894e1443-dd7a-4b9d-b253-430c2de80524
      additionalProperties: false
      description: DTO representing jurisdiction of policy requirement
    InitiateIdvRequirementsValidationDto:
      type: object
      properties:
        entityId:
          type: string
          description: The UiD of the Entity
          format: uuid
          example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6
        entityDraftId:
          type: string
          description: The UiD of the Entity Draft
          format: uuid
          example: 24511767-4586-4b69-af43-c405ec6b154a
        journeyId:
          type: string
          description: The UiD of the Journey
          format: uuid
          example: 7a15bd4a-20f7-497f-b16a-a75d52c8fe01
        taskId:
          type: string
          description: The UiD of the Journey
          format: uuid
          example: e205ea02-72c6-4aa6-9a10-804a3c78ccaf
        entityType:
          type:
          - string
          - 'null'
          description: Entity Type
          example: Company
        categories:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Categories to be used for Idv requirements validation
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto'
          description: Jurisdictions to be used for Idv requirements validation
        ruleSetId:
          type:
          - string
          - 'null'
          description: The ID of the Related Party Scoping Rule Set to scope the entity-in-scope lookup by, if any
          format: uuid
          example: b1e0a2a4-9b8b-4e2a-9f2a-0b7e2a4a2a4a
      additionalProperties: false
      description: DTO representing initialization of Idv requirements validation business process
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    IdvRequirementsValidationBusinessProcessDto:
      type: object
      properties:
        businessProcessId:
          type: string
          description: The UiD of the business process
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        status:
          type:
          - string
          - 'null'
          description: Status of business process
          example: In Progress
        payload:
          allOf:
          - $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessPayloadDto'
          description: Business process payload
        created:
          type: string
          description: Business process created date
          format: date-time
          example: '2021-01-05T14:48:00.000Z'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BusinessProcessMessageDto'
          description: Business process messages
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessItemDto'
          description: Business Process items
      additionalProperties: false
      description: Response DTO representing Idv requirements validation business process
    IdvRequirementValidationErrorDto:
      type: object
      properties:
        errorMessage:
          type:
          - string
          - 'null'
          description: Error message
          example: Field is required
      additionalProperties: false
      description: Response DTO representing validation error data of Idv requirements validation business process item
    IdvRequirementsValidationBusinessProcessItemDto:
      type: object
      properties:
        requirementId:
          type: string
          description: The UiD of the Idv requirement
          format: uuid
          example: a5cfd4e8-732f-4601-ac88-652b64c8439c
        idvLabel:
          type:
          - string
          - 'null'
          description: Label of the Idv requirement
          example: Idv requirement label
        idvTooltip:
          type:
          - string
          - 'null'
          description: Tooltip of the Idv requirement
          example: Idv requirement tooltip
        category:
          type:
          - string
          - 'null'
          description: Category of the Idv requirement
          example: Basic Details
        isValid:
          type: boolean
          description: Flag to determine if Idv requirements validation business process item is valid or not
          example: true
        validationErrors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IdvRequirementValidationErrorDto'
          description: Validation errors of the Idv requirements validation business process item
        relationshipTypes:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Relationship types of the Idv requirements validation business process item
        status:
          type:
          - string
          - 'null'
          description: Status of the Idv requirements validation business process item
          example: In Progress
      additionalProperties: false
      description: Response DTO representing Idv requirements validation business process item
    BusinessProcessMessageDto:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: Business process message
          example: Error occurred
        messageType:
          type:
          - string
          - 'null'
          description: Type of business process message
          example: Error
      additionalProperties: false
      description: Response DTO representing business process message
    VersionedJurisdictionDto_2:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction of the requirement
          example: Global
        versionId:
          type:
          - string
          - 'null'
          description: Version of the requirement jurisdiction
          format: uuid
          example: 894e1443-dd7a-4b9d-b253-430c2de80524
      additionalProperties: false
      description: DTO representing jurisdiction of policy requirement
    IdvRequirementsValidationBusinessProcessDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/IdvRequirementsValidationBusinessProcessDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    IdvRequirementsValidationBusinessProcessPayloadDto:
      type: object
      properties:
        entityId:
          type: string
          description: The UiD of the Entity
          format: uuid
          example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6
        entityDraftId:
          type: string
          description: The UiD of the Entity Draft
          format: uuid
          example: 24511767-4586-4b69-af43-c405ec6b154a
        journeyId:
          type: string
          description: The UiD of the Journey
          format: uuid
          example: 7a15bd4a-20f7-497f-b16a-a75d52c8fe01
        taskId:
          type: string
          description: The UiD of the Task
          format: uuid
          example: e205ea02-72c6-4aa6-9a10-804a3c78ccaf
        entityType:
          type:
          - string
          - 'null'
          description: Entity Type
          example: Company
        categories:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Categories used for Idv requirements validation business process
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_2'
          description: Jurisdictions used for Idv requirements validation business process
      additionalProperties: false
      description: Response DTO representing Idv requirements validation business process payload
    VersionedJurisdictionDto_3:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction of the requirement
          example: Global
        versionId:
          type:
          - string
          - 'null'
          description: Version of the requirement jurisdiction
          format: uuid
          example: 894e1443-dd7a-4b9d-b253-430c2de80524
      additionalProperties: false
      description: DTO representing jurisdiction of policy requirement
    IdvRequirementsValidationBusinessProcessPayloadDto_2:
      type: object
      properties:
        entityId:
          type: string
          description: The UiD of the Entity
          format: uuid
          example: 58e4b43a-a082-49a6-bf79-0cf8df2313c6
        entityDraftId:
          type: string
          description: The UiD of the Entity Draft
          format: uuid
          example: 24511767-4586-4b69-af43-c405ec6b154a
        journeyId:
          type: string
          description: The UiD of the Journey
          format: uuid
          example: 7a15bd4a-20f7-497f-b16a-a75d52c8fe01
        taskId:
          type: string
          description: The UiD of the Task
          format: uuid
          example: e205ea02-72c6-4aa6-9a10-804a3c78ccaf
        entityType:
          type:
          - string
          - 'null'
          description: Entity Type
          example: Company
        categories:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Categories used for Idv requirements validation business process
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: Jurisdictions used for Idv requirements validation business process
      additionalProperties: false
      description: Response DTO representing Idv requirements validation business process payload
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-digitalidvcommand-v1-0-openapi.json
- fenergo-digitalidvcommand-v2-0-openapi.json
- fenergo-digitalidvquery-v1-0-openapi.json
- fenergo-digitalidvquery-v2-0-openapi.json