openapi: 3.2.0
info:
  title: Fenergo Entity In Scope For Idv API
  version: '1.0'
  description: 'Operations tagged EntityInScopeForIdv 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: EntityInScopeForIdv
paths:
  /api/entity-in-scope:
    post:
      tags:
      - EntityInScopeForIdv
      summary: Creates an Entity in Scope for Idv
      description: 'Required permissions:

        Following permissions are required: IdvEdit'
      operationId: CreateEntityInScopeForIdv
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: The request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: EntityInScopeForIdvDto model created successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoServiceResponse'
        '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/entity-in-scope/{id}:
    put:
      tags:
      - EntityInScopeForIdv
      summary: Updates the Entity in Scope for Idv
      description: 'Required permissions:

        Following permissions are required: IdvEdit'
      operationId: UpdateEntityInScopeForIdv
      parameters:
      - name: id
        in: path
        description: The 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
      requestBody:
        description: The status.
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
          application/*+json:
            schema:
              type: string
      responses:
        '202':
          description: EntityInScopeForIdvDto model updated successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/UpdateEntityInScopeForIdvResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEntityInScopeForIdvResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/UpdateEntityInScopeForIdvResponseDtoServiceResponse'
        '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'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. No Entity In Scope was found for the Id provided
                  type: Error
                  errorCode: Error Code
        '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
    delete:
      tags:
      - EntityInScopeForIdv
      summary: Deletes the Entity in Scope for Idv
      description: 'Required permissions:

        Following permissions are required: IdvDelete'
      operationId: DeleteEntityInScopeForIdv
      parameters:
      - name: id
        in: path
        description: The 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:
        '202':
          description: EntityInScopeForIdvDto model deleted successfully
        '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'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. No Entity In Scope was found for the Id provided
                  type: Error
                  errorCode: Error Code
        '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/entity-in-scope/evaluate-create-idv-status:
    post:
      tags:
      - EntityInScopeForIdv
      summary: Evaluate and create IDV model for an entity
      description: 'Evaluates an entity''s data and documents against their policy requirements


        Creates the aggregate model and returns an IDV compliance status


        Required permissions:

        Following permissions are required: IdvEdit'
      operationId: EvaluateCreateIdvStatus
      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: Service request containing a Fenergo.Nebula.DigitalIDV.IDVComplianceEngine.Application.Dto.EvaluateIdvStatusRequestDto with IDs required for evaluation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: IDV model successfully evaluated and created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
        '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/entity-in-scope/evaluate-update-idv-status/{id}:
    put:
      tags:
      - EntityInScopeForIdv
      summary: Evaluate and update IDV model for an entity
      description: 'Evaluates an entity''s data and documents against their policy requirements


        Updates the aggregate model and returns an IDV compliance status


        Required permissions:

        Following permissions are required: IdvEdit'
      operationId: EvaluateUpdateIdvStatus
      parameters:
      - name: id
        in: path
        description: The 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
      requestBody:
        description: Service request containing a Fenergo.Nebula.DigitalIDV.IDVComplianceEngine.Application.Dto.EvaluateIdvStatusRequestDto with IDs required for evaluation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: IDV model successfully evaluated and created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
        '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/entity-in-scope:
    post:
      tags:
      - EntityInScopeForIdv
      summary: Includes an Entity in Scope for Idv
      description: 'Required permissions:

        Following permissions are required: IdvEdit'
      operationId: IncludeEntityInScopeForIdv
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: The request.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoV2ServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoV2ServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoV2ServiceRequest'
              description: Service request data
      responses:
        '202':
          description: EntityInScopeForIdvDto model created successfully
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoV2ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoV2ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoV2ServiceResponse'
        '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/entity-in-scope/exclude:
    put:
      tags:
      - EntityInScopeForIdv
      summary: Excludes the Entity from Scope for Idv
      description: 'Required permissions:

        Following permissions are required: IdvRemoveScope'
      operationId: ExcludeEntityFromScopeForIdv
      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:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ExcludeEntityFromScopeDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ExcludeEntityFromScopeDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ExcludeEntityFromScopeDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: EntityInScopeForIdvDto model deleted successfully
        '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'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. No Entity In Scope was found for the Id provided
                  type: Error
                  errorCode: Error Code
        '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/entity-in-scope/evaluate-update-idv-status/{id}:
    put:
      tags:
      - EntityInScopeForIdv
      summary: Evaluate and update IDV model for an entity
      description: 'Evaluates an entity''s data and documents against their policy requirements


        Updates the aggregate model and returns an IDV compliance status


        Required permissions:

        Following permissions are required: IdvEdit'
      operationId: putApiV2EntityInScopeEvaluateUpdateIdvStatusById
      parameters:
      - name: id
        in: path
        description: The 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
      requestBody:
        description: Service request containing a Fenergo.Nebula.DigitalIDV.IDVComplianceEngine.Application.Dto.EvaluateIdvStatusRequestDto with IDs required for evaluation
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusExtendedRequestDtoServiceRequest'
              description: Service request data
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusExtendedRequestDtoServiceRequest'
              description: Service request data
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateIdvStatusExtendedRequestDtoServiceRequest'
              description: Service request data
      responses:
        '202':
          description: IDV model successfully evaluated and created
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDtoServiceResponse'
        '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
      x-operation-id-source: normalized
      x-operation-id-original: EvaluateUpdateIdvStatus
    servers:
    - url: /digitalidvcommand
  /api/entity-in-scope/journey/{journeyId}:
    get:
      tags:
      - EntityInScopeForIdv
      summary: Gets all by journey identifier
      description: 'Required permissions:

        Following permissions are required: IdvAccess'
      operationId: GetAllByJourneyId
      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.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDto class representing the Entity In Scope if found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoIEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoIEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoIEnumerableServiceResponse'
        '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/entity-in-scope/journey/{journeyId}/entity/{entityId}:
    get:
      tags:
      - EntityInScopeForIdv
      summary: Gets an Entity In Scope by Journey Id and Entity Id
      description: 'Required permissions:

        Following permissions are required: IdvAccess'
      operationId: GetByJourneyIdAndEntityId
      parameters:
      - name: journeyId
        in: path
        description: The Journey identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: The Entity 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.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDto class representing the Entity In Scope if found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The Entity is not in scope for the Journey Id and Entity Id provided
                  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/entity-in-scope/journey/{journeyId}/ruleset/{rulesetId}:
    get:
      tags:
      - EntityInScopeForIdv
      summary: Gets all by journey identifier
      description: 'Required permissions:

        Following permissions are required: IdvAccess'
      operationId: GetAllByJourneyIdRuleSetId
      parameters:
      - name: journeyId
        in: path
        description: The journey identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: rulesetId
        in: path
        description: The ruleset 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.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDtoV2 class representing the Entity In Scope if found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoV2IEnumerableServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoV2IEnumerableServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoV2IEnumerableServiceResponse'
        '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/entity-in-scope/journey/{journeyId}/entity/{entityId}/ruleset/{rulesetId}:
    get:
      tags:
      - EntityInScopeForIdv
      summary: Gets an Entity In Scope by Journey Id and Entity Id
      description: 'Required permissions:

        Following permissions are required: IdvAccess'
      operationId: GetByJourneyAndEntityIdRuleSetId
      parameters:
      - name: journeyId
        in: path
        description: The Journey identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: The Entity identifier.
        required: true
        schema:
          type: string
          format: uuid
      - name: rulesetId
        in: path
        description: The ruleset 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.DigitalIDV.Query.Application.Dto.EntityInScopeForIdvDtoV2 class representing the Entity In Scope if found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoV2ServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoV2ServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EntityInScopeForIdvDtoV2ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found. The Entity is not in scope for the Journey Id and Entity Id provided
                  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/entity-in-scope/evaluate:
    post:
      tags:
      - EntityInScopeForIdv
      summary: Evaluates a set of related parties against a scoping rule set on demand
      description: 'Required permissions:

        At least one of the following permissions is required: DigitalIdvAccess, IdvAccess'
      operationId: EvaluateEntitiesInScope
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: 'The evaluation request: the rule set, the root client and the related parties to evaluate.'
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateEntitiesInScopeRequest'
              description: 'HTTP request body for the on-demand related-party scoping evaluation.

                The tenant is taken from the request security context, not the body.'
          text/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateEntitiesInScopeRequest'
              description: 'HTTP request body for the on-demand related-party scoping evaluation.

                The tenant is taken from the request security context, not the body.'
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EvaluateEntitiesInScopeRequest'
              description: 'HTTP request body for the on-demand related-party scoping evaluation.

                The tenant is taken from the request security context, not the body.'
      responses:
        '200':
          description: A Fenergo.Nebula.DigitalIDV.Query.Application.Dto.EntitiesInScope.EvaluateEntitiesInScopeDto with the ids of the related parties that are in scope.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/EvaluateEntitiesInScopeDtoServiceResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluateEntitiesInScopeDtoServiceResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/EvaluateEntitiesInScopeDtoServiceResponse'
        '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:
    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
    EntityInScopeForIdvRequestDto:
      type: object
      properties:
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the Entity the which is in scope for Idv
          example: 315df981-38a0-4145-836b-8d22745887b6
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the Journey the Entity in scope for Idv is on
          example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
      additionalProperties: false
    EvaluateIdvStatusRequestDto:
      type: object
      properties:
        journeyId:
          type: string
          format: uuid
        taskId:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        entityDraftId:
          type: string
          format: uuid
        rootId:
          type: string
          format: uuid
        parentDraftId:
          type: string
          format: uuid
      additionalProperties: false
    EntityInScopeForIdvResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The Id of the Entity in Scope for Idv
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the Entity the which is in Scope for Idv
          example: 315df981-38a0-4145-836b-8d22745887b6
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the Journey the Entity in Scope for Idv is on
          example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
        status:
          type:
          - string
          - 'null'
          description: The status of the Entity in Scope for Idv
          example: Pending Data
      additionalProperties: false
    EvaluateAndSetIdvStatusResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EvaluateAndSetIdvStatusResponseDto'
          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
    EntityInScopeForIdvRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityInScopeForIdvRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EvaluateAndSetIdvStatusResponseDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        journeyId:
          type: string
          format: uuid
        status:
          type:
          - string
          - 'null'
      additionalProperties: false
    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
    UpdateEntityInScopeForIdvResponseDto:
      type: object
      properties:
        id:
          type: string
          description: The Id of the Entity in Scope for Idv
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        status:
          type:
          - string
          - 'null'
          description: The status of the Entity in Scope for Idv
          example: Pending Data
      additionalProperties: false
    UpdateEntityInScopeForIdvResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateEntityInScopeForIdvResponseDto'
          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
    EntityInScopeForIdvResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityInScopeForIdvResponseDto'
          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
    EvaluateIdvStatusRequestDtoServiceRequest:
      required:
      - data
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EvaluateIdvStatusRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request 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
    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
    ExcludeEntityFromScopeDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ExcludeEntityFromScopeDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EntityInScopeForIdvResponseDtoV2ServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityInScopeForIdvResponseDtoV2'
          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
    EntityInScopeForIdvRequestDtoV2ServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityInScopeForIdvRequestDtoV2'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EvaluateIdvStatusExtendedRequestDtoServiceRequest:
      required:
      - data
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EvaluateIdvStatusExtendedRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EntityInScopeForIdvRequestDtoV2:
      allOf:
      - $ref: '#/components/schemas/EntityInScopeForIdvRequestDto'
      - type: object
        properties:
          ruleSetId:
            type:
            - string
            - 'null'
            description: The Id of the ruleset for the task which in scope for Idv
            example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
        additionalProperties: false
    ExcludeEntityFromScopeDto:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
      additionalProperties: false
    EntityInScopeForIdvResponseDtoV2:
      allOf:
      - $ref: '#/components/schemas/EntityInScopeForIdvResponseDto'
      - type: object
        properties:
          ruleSetId:
            type:
            - string
            - 'null'
            description: The Id of the ruleset for the task which in scope for Idv
            example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
          isExcluded:
            type: boolean
            description: Is entity excluded from scope for Idv
            example: false
        additionalProperties: false
    EvaluateIdvStatusExtendedRequestDto:
      allOf:
      - $ref: '#/components/schemas/EvaluateIdvStatusRequestDto'
      - type: object
        properties:
          parentEntities:
            type:
            - array
            - 'null'
            items:
              type: string
              format: uuid
          gatheredComplianceData:
            type:
            - object
            - 'null'
            additionalProperties:
              type:
              - string
              - 'null'
        additionalProperties: false
    EntityInScopeForIdvDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityInScopeForIdvDto'
          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
    EntityInScopeForIdvDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityInScopeForIdvDto'
          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
    EntityInScopeForIdvDto:
      type: object
      properties:
        id:
          type: string
          description: The Id of the Entity in Scope for Idv
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the Entity the which is in Scope for Idv
          example: 315df981-38a0-4145-836b-8d22745887b6
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the Journey the Entity in Scope for Idv is on
          example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
        status:
          type:
          - string
          - 'null'
          description: The status of the Entity in Scope for Idv
          example: Pending Data
      additionalProperties: false
    EvaluateEntitiesInScopeRequest:
      type: object
      properties:
        scopingRuleSetId:
          type: string
          description: The scoping rule set to evaluate against. When System.Guid.Empty (no rule configured), every related party is treated as in scope.
          format: uuid
        relatedClient:
          allOf:
          - $ref: '#/components/schemas/EntitySnapshotDto'
          description: The root client the related parties are associated to.
        relatedParties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RelatedPartyInScopeDto'
          description: The related parties to evaluate, each with the associations sourced from it.
      additionalProperties: false
      description: 'HTTP request body for the on-demand related-party scoping evaluation.

        The tenant is taken from the request security context, not the body.'
    PropertyType:
      enum:
      - Single
      - Custom
      - Collection
      type: string
    EvaluateEntitiesInScopeDto:
      type: object
      properties:
        inScopeEntityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: The ids of the related parties that satisfy the scoping rule set.
      additionalProperties: false
      description: 'Result of an on-demand scoping evaluation: the ids of the related parties that are in scope.'
    EntityInScopeForIdvDtoV2ServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityInScopeForIdvDtoV2'
          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
    AssociationDto:
      type: object
      properties:
        sourceId:
          type:
          - string
          - 'null'
        targetId:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        ultimateOwnership:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    EvaluateEntitiesInScopeDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EvaluateEntitiesInScopeDto'
          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
    EntitySnapshotDto:
      type: object
      properties:
        id:
          type: string
          description: Entity/Entity Draft Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        sourceEntityId:
          type: string
          description: Source Entity Id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        type:
          type:
          - string
          - 'null'
          description: Entity type
          example: Individual
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: Entity properties
      additionalProperties: false
    EntityInScopeForIdvDtoV2IEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityInScopeForIdvDtoV2'
          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
    RelatedPartyInScopeDto:
      type: object
      properties:
        entity:
          allOf:
          - $ref: '#/components/schemas/EntitySnapshotDto'
          description: The related party entity snapshot (id, type and properties).
        associations:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssociationDto'
          description: The associations sourced from this related party (sourceId, targetId, type, ultimate ownership, properties).
      additionalProperties: false
      description: A related party candidate to evaluate, together with the association(s) that connect it to the client hierarchy.
    PropertyDto:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of property.
          readOnly: true
          example: Single
      additionalProperties: false
      description: Abstraction that represents properties
    EntityInScopeForIdvDtoV2:
      type: object
      properties:
        id:
          type: string
          description: The Id of the Entity in Scope for Idv
          format: uuid
          example: dc30fd5b-120b-4aaa-bed7-8d8508e24de5
        ruleSetId:
          type:
          - string
          - 'null'
          description: The Id of the ruleset for the task which in scope for Idv
          example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
        entityId:
          type:
          - string
          - 'null'
          description: The Id of the Entity the which is in Scope for Idv
          example: 315df981-38a0-4145-836b-8d22745887b6
        journeyId:
          type:
          - string
          - 'null'
          description: The Id of the Journey the Entity in Scope for Idv is on
          example: 19f0ce3c-62cc-4c6d-8d21-cdb8e8f47769
        status:
          type:
          - string
          - 'null'
          description: The status of the Entity in Scope for Idv
          example: Pending Data
        isExcluded:
          type: boolean
          description: Is entity excluded from scope for Idv
          example: false
      additionalProperties: false
  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