openapi: 3.2.0
info:
  title: Fenergo Entity API
  version: '1.0'
  description: 'Operations tagged Entity across 14 of this provider''s published API definitions: fenergo-associationcommand-v1-0-openapi.json, fenergo-associationcommand-v2-0-openapi.json, fenergo-associationquery-v1-0-openapi.json, fenergo-auditquery-v3-0-openapi.json, fenergo-entitydatacommand-v1-0-openapi.json, fenergo-entitydatacommand-v2-0-openapi.json, fenergo-entitydataquery-v1-0-openapi.json, fenergo-entitydataquery-v2-0-openapi.json, fenergo-screeningcommand-v1-0-openapi.json…'
servers:
- url: /associationcommand
- url: /associationquery
- url: /auditquery
- url: /entitydatacommand
- url: /entitydataquery
- url: /screeningcommand
- url: /screeningquery
security:
- Bearer: []
tags:
- name: Entity
paths:
  /api/entity/{id}:
    put:
      tags:
      - Entity
      summary: Update an existing entity
      description: 'This method will update the metadata of an existing Entity

        with the data contained in the request DTO.


        Required permissions:

        At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, EntityGroupManagementEdit, AssociationEditAndLinkOnly'
      operationId: UpdateEntity
      parameters:
      - name: id
        in: path
        description: The Id of the existing Entity to update
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ServiceRequest with the updated Fenergo.Nebula.Association.EntityCommand.Application.Dto.EntityDto
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityDtoServiceRequest'
      responses:
        '202':
          description: Entity model updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDtoServiceResponse'
        '400':
          description: Model Id is invalid
          content:
            application/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
                  type: Error
                  errorCode: Error Code
        '500':
          description: An exception occurred while processing the command
        '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
    get:
      tags:
      - Entity
      summary: Get an existing Entity
      description: 'This method returns the association metadata of an entity for a given tenant and id


        Required permissions:

        Following permissions are required: AssociationAccess'
      operationId: GetEntityById
      parameters:
      - name: id
        in: path
        description: Association Entity identifier
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDtoServiceResponse_2'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: No association entity found
                  type: Error
                  errorCode: Error Code
        '500':
          description: An exception occurred while processing the query
        '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: /associationcommand
  /api/v2/entity/{id}:
    put:
      tags:
      - Entity
      summary: Update an existing entity
      description: 'This method will update the metadata of an existing Entity

        with the data contained in the request DTO.


        Required permissions:

        At least one of the following permissions is required: AssociationEdit, AssociationEditAndPartialDelete, AssociationEditOnly, EntityGroupManagementEdit, AssociationEditAndLinkOnly'
      operationId: putApiV2EntityById
      parameters:
      - name: id
        in: path
        description: The Id of the existing Entity to update
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: ServiceRequest with the updated Fenergo.Nebula.Association.EntityCommand.Application.Dto.EntityDto
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityDtoServiceRequest'
      responses:
        '202':
          description: Entity model updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDtoServiceResponse'
        '400':
          description: Model Id is invalid
          content:
            application/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
                  type: Error
                  errorCode: Error Code
        '500':
          description: An exception occurred while processing the command
        '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: UpdateEntity
    get:
      tags:
      - Entity
      summary: Get entity by id
      description: 'Returns entity for given id.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: getApiV2EntityById
      parameters:
      - name: id
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. An instance of entity is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDtoServiceResponse_4'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found. Entity with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: GetEntityById
    servers:
    - url: /associationcommand
  /api/v3/entity/{entityId}/audit-event-summaries:
    post:
      tags:
      - Entity
      summary: Retrieve entity-specific audit events grouped and summarized by the fields that…
      description: 'This method requires the primary EntityId and optionally a list of EntityDraftIds, and it returns a list of Audit Events grouped and summarized by field name.


        Each record in the returned list contains the original and last updated values.


        Note: To retrieve a complete list of updated fields for a particular Entity, include all EntityDraftIds in the request.


        Required permissions:

        Following permissions are required: AuditAccessAndSearch'
      operationId: GetAuditEventSummariesByFieldName
      parameters:
      - name: entityId
        in: path
        description: The Unique ID of the Entity.
        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: Entity Audit Event Summaries Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetAuditEventSummariesByFieldNameRequestDtoServiceRequest'
      responses:
        '200':
          description: Success. The list of summarized audit events is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditEventSummariesByFieldNameResultDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '413':
          description: Payload Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: The amount of data requested is too large. Please request smaller data set.
                  type: Error
                  errorCode: PAYLOAD_TOO_LARGE
        '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: /auditquery
  /api/v3/entity/{entityId}/{fieldName}/audit-events:
    post:
      tags:
      - Entity
      summary: Retrieve entity-specific audit events for a particular field
      description: 'This method requires the primary EntityId, FieldName, and optionally a list of EntityDraftIds, and it returns a list of Audit Events for the specified FieldName.


        To retrieve a complete list of Audit Event entries for the specified field, ensure that both the Entity ID and all related Entity Draft IDs are included in the request.


        Required permissions:

        Following permissions are required: AuditAccessAndSearch'
      operationId: GetAuditEventsForField
      parameters:
      - name: entityId
        in: path
        description: The Unique ID of the Entity.
        required: true
        schema:
          type: string
          format: uuid
      - name: fieldName
        in: path
        description: The name of the field for which to retrieve Entity Audit Events.
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Entity Audit Event Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetAuditEventsForFieldRequestDtoServiceRequest'
      responses:
        '200':
          description: Success. The list of entity-specific audit events for the given field is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditEventsForFieldQueryResultDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '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: /auditquery
  /api/v3/entity/{entityId}/{fieldName}/audit-events/reveal:
    post:
      tags:
      - Entity
      summary: Reveal entity-specific audit events for a particular field that is marked as…
      description: 'This method requires the primary EntityId, FieldName, and optionally a list of EntityDraftIds, and it returns a list of Audit Events for the specified FieldName.


        This method will authorize the request and if the correct permissions are in place, will reveal the values if the field is marked as Sensitive Data


        To retrieve a complete list of Audit Event entries for the specified field, ensure that both the Entity ID and all related Entity Draft IDs are included in the request.


        Required permissions:

        Following permissions are required: AuditAccessAndSearch'
      operationId: RevealAuditEventsForField
      parameters:
      - name: entityId
        in: path
        description: The Unique ID of the Entity.
        required: true
        schema:
          type: string
          format: uuid
      - name: fieldName
        in: path
        description: The name of the field for which to retrieve Entity Audit Events.
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        description: Entity Audit Event Request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RevealAuditEventsForFieldRequestDtoServiceRequest'
      responses:
        '200':
          description: Success. The list of entity-specific audit events for the given field is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevealAuditEventsForFieldQueryResultDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '403':
          description: Forbidden. User has no access to reveal property
        '500':
          description: Internal server error
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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: /auditquery
  /api/entity:
    post:
      tags:
      - Entity
      summary: Create entity
      description: 'Creates a new entity.


        Returns the id of the created entity.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: CreateEntity
      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
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Create entity request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateEntityRequestV2DtoServiceRequest'
      responses:
        '202':
          description: Success. Entity created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCreatedDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydatacommand
  /api/entity/full:
    post:
      tags:
      - Entity
      summary: Create entity with full record in response
      description: 'Creates a new entity.


        Returns the full entity record with all properties.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: CreateEntityFullRecord
      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
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Create entity request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateEntityRequestV2DtoServiceRequest'
      responses:
        '202':
          description: Success. Entity created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCreatedFullRecordDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydatacommand
  /api/entity/{id}/create-url-to-upload-file:
    post:
      tags:
      - Entity
      summary: Create url to upload file.
      description: 'Creates url for file upload.


        Returns url that can be used to upload file.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: CreateUrlToUploadFile
      parameters:
      - name: id
        in: path
        description: Entity id.
        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
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Parameters to create url to upload
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateUrlToUploadFileRequestDtoServiceRequest'
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUrlToUploadFileResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydatacommand
  /api/v2/entity:
    post:
      tags:
      - Entity
      summary: Create entity
      description: 'Creates a new entity.


        Returns the id of the created entity.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: postApiV2Entity
      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
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Create entity request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateEntityRequestV2DtoServiceRequest'
      responses:
        '202':
          description: Success. Entity created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCreatedDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: CreateEntity
    servers:
    - url: /entitydatacommand
  /api/v2/entity/full:
    post:
      tags:
      - Entity
      summary: Create entity with full record in response
      description: 'Creates a new entity.


        Returns the full entity record with all properties.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: postApiV2EntityFull
      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
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Create entity request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateEntityRequestV2DtoServiceRequest'
      responses:
        '202':
          description: Success. Entity created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityCreatedFullRecordDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: CreateEntityFullRecord
    servers:
    - url: /entitydatacommand
  /api/v2/entity/{id}/create-url-to-upload-file:
    post:
      tags:
      - Entity
      summary: Create url to upload file.
      description: 'Creates url for file upload.


        Returns url that can be used to upload file.


        Required permissions:

        At least one of the following permissions is required: EntityDataEdit, EntityGroupManagementEdit'
      operationId: postApiV2EntityByIdCreateUrlToUploadFile
      parameters:
      - name: id
        in: path
        description: Entity id.
        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
      - name: X-CORRELATION-ID
        in: header
        description: The UiD of the correlation id
        schema:
          type: string
        example: fee5b5f5-b220-4fef-ba38-bf802b98d74d
      requestBody:
        description: Parameters to create url to upload
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateUrlToUploadFileRequestDtoServiceRequest'
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUrlToUploadFileResponseDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
      x-operation-id-source: normalized
      x-operation-id-original: CreateUrlToUploadFile
    servers:
    - url: /entitydatacommand
  /api/entity/getentitieslist:
    post:
      tags:
      - Entity
      summary: Get entities by attributes
      description: 'Returns the list of entities with only the data specified in the attributes.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntitiesList
      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: Query entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityQueryDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/getentitiespagedlist:
    post:
      tags:
      - Entity
      summary: Get paged list of entities
      description: 'Returns paged list of entities, these are sorted based on the pagerDto


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntitiesPagedList
      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: Query entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityQueryPagedDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/searchforduplicates:
    post:
      tags:
      - Entity
      summary: Search for entity duplicates
      description: 'Returns possible duplicated entities for given search criteria.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: SearchForDuplicates
      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: Search for duplicates request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SearchForDuplicatesDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/entityadvancedsearch:
    post:
      tags:
      - Entity
      summary: Advanced search for entities
      description: 'Returns entities for given search criteria.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: EntityAdvancedSearch
      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: Search for entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityAdvancedSearchDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvancedSearchResultDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/entityadvancedsearch/file:
    post:
      tags:
      - Entity
      summary: Entity advanced search results file
      description: 'Returns entities for given search criteria as a link to file.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: EntityAdvancedSearchFile
      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: Search for entities file request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityAdvancedSearchFileDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Response represents file search result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvancedSearchFileResultDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/multisearchforduplicates:
    post:
      tags:
      - Entity
      summary: Multi-search for entity duplicates
      description: 'Returns set of possible duplicated entities for each search criteria specify in the request.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: MultiSearchForDuplicates
      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: Multi-search for duplicates request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/MultiSearchForDuplicatesDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Set of possible duplicated entities returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringSearchEntityDtoListDictionaryServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/searchbyname:
    post:
      tags:
      - Entity
      summary: Search entities by name
      description: 'Returns list of possible duplicated entities by provided name.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: SearchByName
      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: Search entities by name request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntitySearchByNameDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDtoListServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/journey/{journeyId}/task/{taskId}:
    get:
      tags:
      - Entity
      summary: Get entities snapshot by Journey Id and Task Id
      description: 'Returns a list of entities for a given Journey Id and Task Id.


        Required permissions:

        Following permissions are required: EntityDataAccessAndSearch'
      operationId: GetEntitiesSnapshotByTaskId
      parameters:
      - name: journeyId
        in: path
        description: Journey Id id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySnapshotDtoIEnumerableServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Entities snapshot with given Journey Id and Task Id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/{entityId}/journey/{journeyId}/task/{taskId}:
    get:
      tags:
      - Entity
      summary: Get entity snapshot by Journey Id, Task Id and Entity Id
      description: 'Returns a list of entities for a given Journey Id and Task Id.


        Required permissions:

        Following permissions are required: EntityDataAccessAndSearch'
      operationId: GetEntitySnapshotByIdAndTaskId
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Entity Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySnapshotDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Entities snapshot with given Journey Id and Task Id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/{entityId}/version/{entityVersion}:
    get:
      tags:
      - Entity
      summary: Get entity in specified version
      description: 'Gets the entity for the requested version


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntityVersion
      parameters:
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityVersion
        in: path
        description: Version
        required: true
        schema:
          type: integer
          format: int32
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDtoServiceResponse_3'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Entity with given id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '202':
          description: Success. Entity version retrieved
        '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_2'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/{entityId}/property/{propertyName}:
    get:
      tags:
      - Entity
      summary: Get revealed PII property value from Entity
      description: 'Returns unmasked value of requested property name


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntityPIIPropertyValue
      parameters:
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        description: Property Name
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Instance of property is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyDtoServiceResponse'
        '403':
          description: Forbidden. User has no access to reveal property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Entity or PropertyName with given id/name does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/{entityId}/pre-sign-urls:
    post:
      tags:
      - Entity
      summary: Get pre-sign URLs for a file identifiers This endpoint is intended for use with…
      description: 'Returns URLs for each file identifier


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetPreSignUrlForFileIdentifiers
      parameters:
      - name: entityId
        in: path
        description: Entity id
        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: File identifiers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetPreSignUrlsRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Instance of property is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreSignUrlsResponseDtoServiceResponse'
        '403':
          description: Forbidden. User has no access to reveal property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Entity or PropertyName with given id/name does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/report-pre-sign-url:
    post:
      tags:
      - Entity
      summary: Get pre-sign URL for specified report type
      description: 'Returns URL with report file


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetReportPreSignUrl
      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: Get report request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetReportPreSignUrlRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Instance of property is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportPreSignUrlResponseDtoServiceResponse'
        '403':
          description: Forbidden. User has no access to reveal property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: {}
                messages:
                - message: Not Found. Entity or PropertyName with given id/name does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_2'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_2'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_2'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/entityadvancedsearch:
    post:
      tags:
      - Entity
      summary: Advanced search for entities
      description: 'Returns entities for given search criteria.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: postApiV2EntityEntityadvancedsearch
      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: Search for entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityAdvancedSearchDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvancedSearchResultDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: EntityAdvancedSearch
    servers:
    - url: /entitydataquery
  /api/v2/entity/entityadvancedsearch/file:
    post:
      tags:
      - Entity
      summary: Entity advanced search results file
      description: 'Returns entities for given search criteria as a link to file.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: postApiV2EntityEntityadvancedsearchFile
      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: Search for entities file request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityAdvancedSearchFileDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Response represents file search result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdvancedSearchFileResultDtoServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: EntityAdvancedSearchFile
    servers:
    - url: /entitydataquery
  /api/v2/entity/searchbyname:
    post:
      tags:
      - Entity
      summary: Search entities by name
      description: 'Returns list of possible duplicated entities by provided name.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: postApiV2EntitySearchbyname
      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: Search entities by name request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntitySearchByNameDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDtoListServiceResponse_2'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: SearchByName
    servers:
    - url: /entitydataquery
  /api/v2/entity/journey/{journeyId}/task/{taskId}:
    get:
      tags:
      - Entity
      summary: Get entities snapshot by Journey Id and Task Id
      description: 'Returns a list of entities for a given Journey Id and Task Id.


        Required permissions:

        Following permissions are required: EntityDataAccessAndSearch'
      operationId: getApiV2EntityJourneyByJourneyIdTaskByTaskId
      parameters:
      - name: journeyId
        in: path
        description: Journey Id id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySnapshotDtoIEnumerableServiceResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found. Entities snapshot with given Journey Id and Task Id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: GetEntitiesSnapshotByTaskId
    servers:
    - url: /entitydataquery
  /api/v2/entity/{entityId}/journey/{journeyId}/task/{taskId}:
    get:
      tags:
      - Entity
      summary: Get entity snapshot by Journey Id, Task Id and Entity Id
      description: 'Returns a list of entities for a given Journey Id and Task Id.


        Required permissions:

        Following permissions are required: EntityDataAccessAndSearch'
      operationId: getApiV2EntityByEntityIdJourneyByJourneyIdTaskByTaskId
      parameters:
      - name: journeyId
        in: path
        description: Journey Id
        required: true
        schema:
          type: string
          format: uuid
      - name: taskId
        in: path
        description: Task Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityId
        in: path
        description: Entity Id
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitySnapshotDtoServiceResponse_2'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found. Entities snapshot with given Journey Id and Task Id does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: GetEntitySnapshotByIdAndTaskId
    servers:
    - url: /entitydataquery
  /api/v2/entity/{entityId}/property/{propertyName}:
    get:
      tags:
      - Entity
      summary: Get revealed PII property value from Entity
      description: 'Returns unmasked value of requested property name


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: getApiV2EntityByEntityIdPropertyByPropertyName
      parameters:
      - name: entityId
        in: path
        description: Entity id
        required: true
        schema:
          type: string
          format: uuid
      - name: propertyName
        in: path
        description: Property Name
        required: true
        schema:
          type: string
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. Instance of property is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyDtoServiceResponse_2'
        '403':
          description: Forbidden. User has no access to reveal property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_3'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found. Entity or PropertyName with given id/name does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: GetEntityPIIPropertyValue
    servers:
    - url: /entitydataquery
  /api/v2/entity/{entityId}/pre-sign-urls:
    post:
      tags:
      - Entity
      summary: Get pre-sign URLs for a file identifiers This endpoint is intended for use with…
      description: 'Returns URLs for each file identifier


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: postApiV2EntityByEntityIdPreSignUrls
      parameters:
      - name: entityId
        in: path
        description: Entity id
        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: File identifiers request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetPreSignUrlsRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Instance of property is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreSignUrlsResponseDtoServiceResponse_2'
        '403':
          description: Forbidden. User has no access to reveal property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_3'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found. Entity or PropertyName with given id/name does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: GetPreSignUrlForFileIdentifiers
    servers:
    - url: /entitydataquery
  /api/v2/entity/report-pre-sign-url:
    post:
      tags:
      - Entity
      summary: Get pre-sign URL for specified report type
      description: 'Returns URL with report file


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: postApiV2EntityReportPreSignUrl
      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: Get report request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetReportPreSignUrlRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Instance of property is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportPreSignUrlResponseDtoServiceResponse_2'
        '403':
          description: Forbidden. User has no access to reveal property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_3'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found. Entity or PropertyName with given id/name does not exist
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              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: GetReportPreSignUrl
    servers:
    - url: /entitydataquery
  /api/v2/entity/get-entity-drafts-light:
    post:
      tags:
      - Entity
      summary: Lightweight search for entities to return the names for a list of ids
      description: 'Returns set of names and ids for a given list of entities Ids.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntityDraftsLight
      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: Multi-search for duplicates request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetEntityDraftsLightRequestDtoServiceRequest'
              description: Service request data
      responses:
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '200':
          description: Success. Set of Names and Ids returned as paged lists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntityDraftsLightResponseDtoServiceResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_3'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/getentitiespagedlist:
    post:
      tags:
      - Entity
      summary: Get paged list of entities with total items in the response
      description: 'Returns paged list of entities, these are sorted based on the pagerDto


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntitiesPagedListV2
      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: Query entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityQueryPagedDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The paged list of entities is returned with total items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDtoPagedListDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/names:
    post:
      tags:
      - Entity
      summary: Get a list of entity names by their IDs
      description: 'Returns a list of entity names, types and ids


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntityNamesByIds
      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: Query entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetEntityNamesByIdsRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. A dictionary of entity names, types and ids is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityNamesDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/searchforduplicates:
    post:
      tags:
      - Entity
      summary: Search for entity duplicates
      description: 'Returns possible duplicated entities for given search criteria.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: SearchForDuplicatesV2
      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: Search for duplicates request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SearchForDuplicatesDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The paged list of entities is returned with total items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchEntityDtoPagedListDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/multisearchforduplicates:
    post:
      tags:
      - Entity
      summary: Multi-search for entity duplicates
      description: 'Returns set of possible duplicated entities for each search criteria specify in the request.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: MultiSearchForDuplicatesV2
      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: Multi-search for duplicates request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/MultiSearchForDuplicatesDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Set of possible duplicated entities returned as paged lists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringSearchEntityDtoPagedListDtoDictionaryServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/search/by-ids:
    post:
      tags:
      - Entity
      summary: Search entity by ids with the given properties
      description: 'Returns set of entities properties for each entity id.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: SearchByIds
      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: Search for entities request by ids and params
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/SearchByIdsRequestDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. Set of entities returned as paged lists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchByIdsEntityResponseDtoPagedListDtoServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/get-conflicts-exist-journey:
    post:
      tags:
      - Entity
      summary: Check for unresolved conflicts in a journey
      description: 'Returns whether there are unresolved conflicts for the given entity Ids in a journey.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntityConflictsExistInJourney
      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: Request by EntityIds and JourneyId
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/GetEntityDraftsLightRequestDtoServiceRequest'
              description: Service request data
      responses:
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictsExistReponseDtoServiceResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse_3'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/v2/entity/get-entities-list:
    post:
      tags:
      - Entity
      summary: Get entities with 'Entity' access layer verification
      description: 'Returns the list of accesible and list of inaccessible entities due to ''Entity'' access layer constraint.


        Required permissions:

        At least one of the following permissions is required: EntityDataAccessAndSearch, EntityGroupManagementAccessAndSearch'
      operationId: GetEntitiesListV2
      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: Query entities request
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EntityQueryDtoServiceRequest'
              description: Service request data
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntitiesListV2ResponseServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorModelListServiceResponse_3'
        '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_3'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '500':
          description: Internal server exception. Please, contact your provider.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse_3'
              example:
                data: null
                messages:
                - message: Internal server exception. Please, contact your provider.
                  type: Error
                  errorCode: INTERNAL_SERVER_ERROR
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringServiceResponse_3'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /entitydataquery
  /api/entity/ongoingscreening:
    put:
      tags:
      - Entity
      summary: Enables or disables ongoing screening for a list of entities
      description: 'This method is used to enable or disable ongoing screening for a list of entities.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: OngoingScreening
      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 with the list of entities for which ongoing screening should be enabled or disabled
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OngoingScreeningDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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: /screeningcommand
  /api/entity/{entityId}:
    put:
      tags:
      - Entity
      summary: Updates an existing Screening entity with the data supplied in the request body…
      description: 'This method is used to update the data of an existing Screening entity.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: putApiEntityByEntityId
      parameters:
      - name: entityId
        in: path
        description: The Screening ID of the entity that is going to be updated
        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 request with the new data of the entity that is going to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateEntityDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '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: UpdateEntity
    servers:
    - url: /screeningcommand
  /api/entity/ongoingscreening/generate-report:
    post:
      tags:
      - Entity
      summary: Generate report with all entities that have ongoing screening enabled for some…
      description: 'This method returns a signed url that allows to download a json with all entities

        that have ongoing screening enabled for some provider.


        The signed url could return an XML file with error code "NoSuchKey" when called. This means that

        the report is still being generated and the signed url needs to be queried again later.


        The signed url expires a few minutes after it''s generated.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetEntitiesSubscribedToOgs
      parameters:
      - name: includeSearchCriteria
        in: query
        schema:
          type: boolean
          default: false
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The sign url to download the report is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntitiesSubscribedToOgsResponseDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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: /screeningcommand
  /api/v2/entity/ongoingscreening:
    put:
      tags:
      - Entity
      summary: Enables or disables ongoing screening for a list of entities
      description: 'This method is used to enable or disable ongoing screening for a list of entities.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: putApiV2EntityOngoingscreening
      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 with the list of entities for which ongoing screening should be enabled or disabled
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OngoingScreeningDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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: OngoingScreening
    servers:
    - url: /screeningcommand
  /api/v2/entity/{entityId}:
    put:
      tags:
      - Entity
      summary: Updates an existing Screening entity with the data supplied in the request body…
      description: 'This method is used to update the data of an existing Screening entity.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: putApiV2EntityByEntityId
      parameters:
      - name: entityId
        in: path
        description: The Screening ID of the entity that is going to be updated
        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 request with the new data of the entity that is going to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateEntityDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '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: UpdateEntity
    servers:
    - url: /screeningcommand
  /api/v2/entity/ongoingscreening/generate-report:
    post:
      tags:
      - Entity
      summary: Generate report with all entities that have ongoing screening enabled for some…
      description: 'This method returns a signed url that allows to download a json with all entities

        that have ongoing screening enabled for some provider.


        The signed url could return an XML file with error code "NoSuchKey" when called. This means that

        the report is still being generated and the signed url needs to be queried again later.


        The signed url expires a few minutes after it''s generated.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: postApiV2EntityOngoingscreeningGenerateReport
      parameters:
      - name: includeSearchCriteria
        in: query
        schema:
          type: boolean
          default: false
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The sign url to download the report is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntitiesSubscribedToOgsResponseDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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: GetEntitiesSubscribedToOgs
    servers:
    - url: /screeningcommand
  /api/v3/entity/toggle-ongoing-screening:
    post:
      tags:
      - Entity
      summary: Enables or disables ongoing screening for a list of entities
      description: 'If no providers are specified in the request and the "Default" Ongoing Screening mode is set up in the

        tenant for all the providers, the entities will be subscribed or unsubscribed from all available providers

        that have Ongoing Screening enabled.


        If any of the providers in the tenant or specified in the request uses the "Per Configuration Set"

        Ongoing Screening mode, specifying a ConfigurationSetId is mandatory.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: ToggleOngoingScreening
      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 with the list of entities and providers for which ongoing screening should\n            be enabled or disabled"
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ToggleOngoingScreeningDtoServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '403':
          description: Forbidden. The feature is disabled or the user lacks the necessary permissions
          content:
            application/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
        '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: /screeningcommand
  /api/v3/entity:
    post:
      tags:
      - Entity
      summary: Creates new Screening entities in bulk
      description: 'This method is used to create multiple Screening entities at once in a single request.


        Pre-requisites:


        The ''legalEntityId'' supplied for each entity as part of the request should already exist in Fen-X.


        Considerations:


        Each entity in the request is managed as an independent operation. This means that some of the requests may

        be successful and some of them may not. Therefore, it is important to review the properties

        ''numberOfEntitiesCreated'' and ''numberOfEntitiesFailed'' in the response of the endpoint. This will give

        a general view of the outcome of all the operations submitted. In addition, the ''status'' property of the

        response will provide the status of each operation, and the ''errorMessage'' property will tell the reason

        why the operation failed.


        There is a maximum number of entities that can be submitted in a single request. If you hit that limit,

        please split the entities in multiple requests and try again.


        Required permissions:

        Following permissions are required: ScreeningCreate, ScreeningAccess'
      operationId: CreateEntitiesV3
      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 with the list of entities that are going to be created
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/CreateEntityDtoV3ListServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntitiesCreatedDtoV3ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '403':
          description: Forbidden. The feature is disabled or the user lacks the necessary permissions
          content:
            application/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
        '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: /screeningcommand
  /api/v3/entity/{entityId}:
    put:
      tags:
      - Entity
      summary: Updates an existing Screening entity with the data supplied in the request body.
      description: 'This method is used to update the data of an existing Screening entity.


        Required permissions:

        Following permissions are required: ScreeningEdit, ScreeningAccess'
      operationId: UpdateEntityV3
      parameters:
      - name: entityId
        in: path
        description: The Screening ID of the entity that is going to be updated
        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 request with the new data of the entity that is going to be updated
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateEntityDtoV3ServiceRequest'
      responses:
        '202':
          description: Accepted. The request has been accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '403':
          description: Forbidden. The feature is disabled or the user lacks the necessary permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '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: /screeningcommand
  /api/v3/entity/generate-ongoing-screening-report:
    post:
      tags:
      - Entity
      summary: Generate report with all entities that have ongoing screening enabled for some…
      description: 'This method returns a signed url that allows to download a json with all entities

        that have ongoing screening enabled for some provider.


        The signed url could return an XML file with error code "NoSuchKey" when called. This means that

        the report is still being generated and the signed url needs to be queried again later.


        The signed url expires a few minutes after it''s generated.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetEntitiesSubscribedToOgsV3
      parameters:
      - name: includeSearchCriteria
        in: query
        schema:
          type: boolean
          default: false
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The sign url to download the report is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEntitiesSubscribedToOgsResponseDtoServiceResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectServiceResponse'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '403':
          description: Forbidden. The feature is disabled or the user lacks the necessary permissions
          content:
            application/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
        '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: /screeningcommand
  /api/v2/batch/{batchId}/entity:
    get:
      tags:
      - Entity
      summary: Get all entities in a batch
      description: 'This method returns all entities for a given batch ID and tenant ID, without including the matches of each entity.


        The method returns a list of entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetEntitiesByBatchIdV2
      parameters:
      - name: batchId
        in: path
        description: The ID of the batch the entities belong to
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEntityDtoV2IEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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
                  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: /screeningquery
  /api/v2/batch/{batchId}/entity/{entityId}:
    get:
      tags:
      - Entity
      summary: Get data of an entity
      description: 'This method returns the entity data for a given entity ID, batch ID and tenant ID, without including the matches of the entity.


        The method will return the entity object.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetEntityByIdV2
      parameters:
      - name: entityId
        in: path
        description: The ID of the entity
        required: true
        schema:
          type: string
          format: uuid
      - name: batchId
        in: path
        description: The batch ID the entity belongs to
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The entity data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEntityDtoV2ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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. The entity could not be found
                  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: /screeningquery
  /api/v3/batch/{batchId}/entity:
    get:
      tags:
      - Entity
      summary: Get all entities in a batch
      description: 'This method returns all entities for a given batch ID and tenant ID, without including the matches of each entity.


        The method returns a list of entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: getApiV3BatchByBatchIdEntity
      parameters:
      - name: batchId
        in: path
        description: The ID of the batch the entities belong to
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEntityDtoV2IEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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
                  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
      x-operation-id-source: normalized
      x-operation-id-original: GetEntitiesByBatchIdV2
    servers:
    - url: /screeningquery
  /api/v3/batch/{batchId}/entity/{entityId}:
    get:
      tags:
      - Entity
      summary: Get data of an entity
      description: 'This method returns the entity data for a given entity ID, batch ID and tenant ID, without including the matches of the entity.


        The method will return the entity object.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: getApiV3BatchByBatchIdEntityByEntityId
      parameters:
      - name: entityId
        in: path
        description: The ID of the entity
        required: true
        schema:
          type: string
          format: uuid
      - name: batchId
        in: path
        description: The batch ID the entity belongs to
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The entity data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEntityDtoV2ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/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. The entity could not be found
                  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
      x-operation-id-source: normalized
      x-operation-id-original: GetEntityByIdV2
    servers:
    - url: /screeningquery
  /api/v4/batch/{batchId}/entity:
    get:
      tags:
      - Entity
      summary: Get all entities in a batch
      description: 'This method returns all entities for a given batch ID and tenant ID, without including the matches of each entity.


        The method returns a list of entity objects.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetEntitiesByBatchIdV4
      parameters:
      - name: batchId
        in: path
        description: The ID of the batch the entities belong to
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The list of entities is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEntityDtoV3IEnumerableServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '403':
          description: Forbidden. The feature is disabled or the user lacks the necessary permissions
          content:
            application/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. The entity could not be found
                  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
        '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: /screeningquery
  /api/v4/batch/{batchId}/entity/{entityId}:
    get:
      tags:
      - Entity
      summary: Get data of an entity
      description: 'This method returns the entity data for a given entity ID, batch ID and tenant ID, without including the matches of the entity.


        The method will return the entity object.


        Required permissions:

        Following permissions are required: ScreeningAccess'
      operationId: GetEntityByIdV4
      parameters:
      - name: entityId
        in: path
        description: The ID of the entity
        required: true
        schema:
          type: string
          format: uuid
      - name: batchId
        in: path
        description: The batch ID the entity belongs to
        required: true
        schema:
          type: string
          format: uuid
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: Success. The entity data is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchEntityDtoV3ServiceResponse'
        '400':
          description: Bad request. The request has missing/invalid values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
        '403':
          description: Forbidden. The feature is disabled or the user lacks the necessary permissions
          content:
            application/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. The entity could not be found
                  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
        '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: /screeningquery
components:
  schemas:
    ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityDto'
      additionalProperties: false
    ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    ObjectServiceResponse:
      type: object
      properties:
        data: {}
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        type:
          type:
          - string
          - 'null'
      additionalProperties: false
    StringServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityDto_2'
          description: The metadata of an Entity
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityDto_2:
      type: object
      properties:
        id:
          type: string
          description: The UiD of the entity model
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        associatedEntityId:
          type: string
          description: The associated entity id
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        associatedJourneyId:
          type: string
          description: The associated journey id
          format: uuid
          example: 118313c6-91e6-4b05-a537-5a1ab906418f
        type:
          type:
          - string
          - 'null'
          description: The type of the entity
          example: Product
      additionalProperties: false
      description: The metadata of an Entity
    GetAuditEventSummariesByFieldNameRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetAuditEventSummariesByFieldNameRequestDto'
      additionalProperties: false
    EntityAuditEventDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: Unique id
          example: 9f14cdfb-845e-4ec6-803b-17f6b7477b36_lastName
        resourceId:
          type:
          - string
          - 'null'
          description: Resource id
          example: 0bdfeb2c-8b19-4203-a70b-c28b73f392f0
        resourceType:
          type:
          - string
          - 'null'
          description: Resource Type
          example: Entity
        fieldName:
          type:
          - string
          - 'null'
          description: Field name
          example: fieldName
        fieldBeforeValue:
          type:
          - string
          - 'null'
          description: Field name value before
          example: Smith
        fieldAfterValue:
          type:
          - string
          - 'null'
          description: Field name value after
          example: Tucker
        fieldType:
          type:
          - string
          - 'null'
          description: Field type
          example: Single
        lastUpdated:
          type:
          - string
          - 'null'
        lastUpdatedBy:
          type:
          - string
          - 'null'
          description: Last updated by username
          example: Entity data
        journeyName:
          type:
          - string
          - 'null'
          description: Journey name
          example: Screening Individual
        isSensitive:
          type: boolean
          description: Determines if the field holds sensitive PII data
      additionalProperties: false
      description: Response DTO representing entity audit event DTO
    EntityEventDetailResultDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityEventDetailModel'
          description: Items for the current page.
        totalItems:
          type: integer
          description: Total count of items.
          format: int64
          example: 1
      additionalProperties: false
      description: Response DTO representing get by field name entity detail query
    RevealAuditEventsForFieldRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RevealAuditEventsForFieldRequestDto'
      additionalProperties: false
    GetAuditEventsForFieldQueryResultDto:
      allOf:
      - $ref: '#/components/schemas/EntityEventDetailResultDto'
      - type: object
        additionalProperties: false
    GetAuditEventSummariesByFieldNameResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetAuditEventSummariesByFieldNameResultDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetAuditEventsForFieldRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetAuditEventsForFieldRequestDto'
      additionalProperties: false
    GetAuditEventSummariesByFieldNameRequestDto:
      allOf:
      - $ref: '#/components/schemas/AuditEventsRequestBase'
      - type: object
        properties:
          searchPhrase:
            type:
            - string
            - 'null'
            description: An optional search phrase with which you can filter the results
            example: John
        additionalProperties: false
    PagerDto:
      type: object
      properties:
        size:
          type: integer
          format: int32
          exclusiveMinimum: 0
        from:
          minimum: 0
          type: integer
          format: int32
        sortBy:
          type:
          - string
          - 'null'
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder'
      additionalProperties: false
    RevealAuditEventsForFieldQueryResultDto:
      allOf:
      - $ref: '#/components/schemas/EntityEventDetailResultDto'
      - type: object
        additionalProperties: false
    SortOrder:
      enum:
      - Ascending
      - Descending
      type: string
    AuditEventsRequestBase:
      type: object
      properties:
        entityDraftIds:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The list of EntityDraftIds you want to include as part of the query
        excludeDrafts:
          type: boolean
          description: Exclude draft values from search results
        excludeSystemFields:
          type: boolean
          description: Exclude system fields from search results
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto'
          description: Pager details
          example:
            from: 0
            size: 10
            sortOrder: Descending
        journeyReferenceId:
          type:
          - string
          - 'null'
          description: Optional journey reference ID to scope entity-level events to the current journey.
        excludeEventTypes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Optional list of event types to exclude from the results.
      additionalProperties: false
      description: The request object that contains the primary EntityId and, optionally, a list of EntityDraftIds for which to fetch entity specific audit events.
    GetAuditEventSummariesByFieldNameResultDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAuditEventDto'
          description: Items for the current page.
        totalItems:
          type: integer
          description: Total count of items.
          format: int64
          example: 1
      additionalProperties: false
    ValidationErrorModelListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    GetAuditEventsForFieldRequestDto:
      allOf:
      - $ref: '#/components/schemas/AuditEventsRequestBase'
      - type: object
        additionalProperties: false
    ValidationErrorModel:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
        errorMessage:
          type:
          - string
          - 'null'
        attemptedValue: {}
        errorCode:
          type:
          - string
          - 'null'
      additionalProperties: false
    RevealAuditEventsForFieldRequestDto:
      allOf:
      - $ref: '#/components/schemas/AuditEventsRequestBase'
      - type: object
        additionalProperties: false
    EntityEventDetailModel:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Entity field name
          example: lastName
        valueType:
          type:
          - string
          - 'null'
          description: Entity field verified or draft value type
          example: Verified
        valueBefore:
          type:
          - string
          - 'null'
          description: Entity field before value
          example: Smith
        valueAfter:
          type:
          - string
          - 'null'
          description: Entity field after value
          example: Tucker
        dataGroupValues:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AuditFieldChangeDto'
          description: Entity Before and After values for data group type fields
        changedBy:
          type:
          - string
          - 'null'
          description: Entity field changed by user name
          example: test.user@fenergo.com
        updatedOn:
          type:
          - string
          - 'null'
          description: Entity field updated on date
          example: '2021-10-10'
        journeyReferenceId:
          type:
          - string
          - 'null'
          description: Journey id where filed was modified
          example: f9bb19a8-07e7-4306-94c9-a00988eadb0d
        journeyName:
          type:
          - string
          - 'null'
          description: Journey name where filed was modified
          example: Screening Individual
        fieldType:
          type:
          - string
          - 'null'
          description: Entity field type
          example: Single
        isSensitive:
          type: boolean
          description: Determines if the field holds sensitive PII data
      additionalProperties: false
      description: Response DTO representing get by field name entity details result
    RevealAuditEventsForFieldQueryResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/RevealAuditEventsForFieldQueryResultDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetAuditEventsForFieldQueryResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetAuditEventsForFieldQueryResultDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AuditFieldChangeDto:
      type: object
      properties:
        fieldName:
          type:
          - string
          - 'null'
          description: Field name
        oldValue:
          type:
          - string
          - 'null'
          description: Field old value
        newValue:
          type:
          - string
          - 'null'
          description: Field new value
        itemOrdinal:
          type:
          - integer
          - 'null'
          description: '1-based position of the collection item this change belongs to. Only set when the

            owning data group holds more than one item, so consumers can tell same-named

            columns apart without exposing the internal item identifier.'
          format: int32
      additionalProperties: false
      description: DTO representing screening audit match field change
    EntityAssociationDataSource:
      required:
      - associationToClient
      - associationType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        associationType:
          minLength: 1
          type: string
        ownershipPercentage:
          type:
          - number
          - 'null'
          format: double
        associationToClient:
          minLength: 1
          type: string
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    EntityDataMetadataDataSource:
      required:
      - entityType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        entityType:
          minLength: 1
          type: string
      additionalProperties: false
    ManualCreditScreeningDto:
      required:
      - properties
      type: object
      properties:
        taskDataKey:
          type:
          - string
          - 'null'
        taskId:
          type: string
          format: uuid
        entityId:
          type: string
          format: uuid
        creditScreeningOutcome:
          type:
          - string
          - 'null'
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
      additionalProperties: false
    RelatedPartyDto:
      required:
      - properties
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    ReviewAndApprovalDto:
      required:
      - approvalOutcome
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        approvalOutcome:
          type: string
        approvalReason:
          type:
          - string
          - 'null'
        taskId:
          type:
          - string
          - 'null'
        taskDataKey:
          type:
          - string
          - 'null'
      additionalProperties: false
    ChangedFieldsDataSource:
      required:
      - changedFields
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        changedFields:
          type: array
          items:
            $ref: '#/components/schemas/ChangedFieldDto'
      additionalProperties: false
    RelatedAssetDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
      additionalProperties: false
    CreateUrlToUploadFileResponseDto:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
        fileIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityCreatedDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityCreatedDto'
          description: Response DTO representing created entity
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
      example:
        data:
          id: e1809731-77df-4e72-98e7-0d314b7a5151
        messages:
        - message: 'Some sent properties were out of scope and not updated: field'
          type: Warning
        - message: 'Some properties are readonly and were left with existing value or set to default: status'
          type: Warning
    EntityCreatedFullRecordDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityCreatedFullRecordDto'
          description: Response DTO representing created entity
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CurrentFieldDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        currentField:
          type:
          - string
          - 'null'
      additionalProperties: false
    CreateUrlToUploadFileRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateUrlToUploadFileRequestDto'
      additionalProperties: false
    AutoCreditScreeningDataSource:
      required:
      - creditScreenings
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditScreenings:
          type: array
          items:
            $ref: '#/components/schemas/AutoCreditScreeningDto'
        relatedPartyCreditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AutoCreditScreeningDto'
      additionalProperties: false
    SignificanceEngineDataSource:
      required:
      - significanceEngine
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        significanceEngine:
          allOf:
          - $ref: '#/components/schemas/SignificanceEngineDto'
      additionalProperties: false
    CreateUrlToUploadFileResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateUrlToUploadFileResponseDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    JourneyLevelDataDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    PropertyDto:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          readOnly: true
        isValid:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    AccessLayerDto:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
          example:
          - Global
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
          example:
          - Enterprise
        geographicDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of geographic access layers with details about inheritance
        businessRelatedDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of business related access layers with details about inheritance
      additionalProperties: false
      description: Response DTO representing associated access layers
    AutoCreditAssessmentDataSource:
      required:
      - autoCreditAssessments
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        autoCreditAssessments:
          type: array
          items:
            $ref: '#/components/schemas/AutoCreditAssessmentDto'
      additionalProperties: false
    RelatedDocumentVersionedDto:
      type: object
      properties:
        documentKey:
          type:
          - string
          - 'null'
        documentType:
          type:
          - string
          - 'null'
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
      additionalProperties: false
    CollectionItemDto:
      type: object
      properties:
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
      additionalProperties: false
    CollectionPropertyDto2:
      type: object
      properties:
        items:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionItemDto'
        collectionId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    MainEntityDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    VersionedJurisdictionDto:
      required:
      - jurisdiction
      type: object
      properties:
        jurisdiction:
          minLength: 1
          type: string
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
      additionalProperties: false
    RelatedFCRDto:
      required:
      - status
      type: object
      properties:
        status:
          type: string
        createdDate:
          type: string
          format: date-time
        submittedDate:
          type:
          - string
          - 'null'
          format: date-time
      additionalProperties: false
    CustomPropertyDto2:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    RelatedDocumentsDataSource:
      required:
      - documents
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        documents:
          type: array
          items:
            $ref: '#/components/schemas/RelatedDocumentDto'
      additionalProperties: false
    MaskedPropertiesDto:
      type: object
      properties:
        singleProperties:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
          description: Masked single data requirement properties
          example:
          - property1
      additionalProperties: false
      description: Property name list of sensitive data requirements with masked value
    ExternalDataAdapterDataSource:
      required:
      - eventSubtype
      - eventType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        eventType:
          minLength: 1
          type: string
        eventSubtype:
          minLength: 1
          type: string
      additionalProperties: false
    RelatedAssetsDataSource:
      required:
      - assets
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assets:
          type: array
          items:
            $ref: '#/components/schemas/RelatedAssetDto'
      additionalProperties: false
    CurrentDataGroupItemDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    ScreeningMaterialityDataSource:
      required:
      - assessments
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assessments:
          type: array
          items:
            $ref: '#/components/schemas/ScreeningMaterialityAssessmentDto'
      additionalProperties: false
    InvestmentAccountFundDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    DataSourcesDto:
      type: object
      properties:
        entityDataMetadata:
          allOf:
          - $ref: '#/components/schemas/EntityDataMetadataDataSource'
        eventIngress:
          allOf:
          - $ref: '#/components/schemas/EventIngressDataSource'
        changedFields:
          allOf:
          - $ref: '#/components/schemas/ChangedFieldsDataSource'
        relatedClient:
          allOf:
          - $ref: '#/components/schemas/RelatedClientDataSource'
        relatedProducts:
          allOf:
          - $ref: '#/components/schemas/RelatedProductsDataSource'
        currentDataGroupItem:
          allOf:
          - $ref: '#/components/schemas/CurrentDataGroupItemDataSource'
        externalDataAdapter:
          allOf:
          - $ref: '#/components/schemas/ExternalDataAdapterDataSource'
        entityAssociation:
          allOf:
          - $ref: '#/components/schemas/EntityAssociationDataSource'
        manualCreditAssessment:
          allOf:
          - $ref: '#/components/schemas/ManualCreditAssessmentV2DataSource'
        reviewAndApproval:
          allOf:
          - $ref: '#/components/schemas/ReviewAndApprovalDataSource'
        autoCreditAssessment:
          allOf:
          - $ref: '#/components/schemas/AutoCreditAssessmentDataSource'
        manualCreditScreening:
          allOf:
          - $ref: '#/components/schemas/ManualCreditScreeningDataSource'
        collateral:
          allOf:
          - $ref: '#/components/schemas/CollateralDataSource'
        currentJourneys:
          allOf:
          - $ref: '#/components/schemas/CurrentJourneysDataSource'
        autoCreditScreening:
          allOf:
          - $ref: '#/components/schemas/AutoCreditScreeningDataSource'
        currentProduct:
          allOf:
          - $ref: '#/components/schemas/CurrentProductDataSource'
        relatedDeals:
          allOf:
          - $ref: '#/components/schemas/RelatedDealsDataSource'
        mainEntity:
          allOf:
          - $ref: '#/components/schemas/MainEntityDataSource'
        relatedAssets:
          allOf:
          - $ref: '#/components/schemas/RelatedAssetsDataSource'
        relatedAssociations:
          allOf:
          - $ref: '#/components/schemas/RelatedAssociationsDataSource'
        accountRelatedFunds:
          allOf:
          - $ref: '#/components/schemas/AccountRelatedFundsDataSource'
        investmentAccountFund:
          allOf:
          - $ref: '#/components/schemas/InvestmentAccountFundDataSource'
        investmentAccountRelatedFundShareClass:
          allOf:
          - $ref: '#/components/schemas/InvestmentAccountRelatedFundShareClassDataSource'
        journeyLevelData:
          allOf:
          - $ref: '#/components/schemas/JourneyLevelDataDataSource'
        relatedParties:
          allOf:
          - $ref: '#/components/schemas/RelatedPartiesDataSource'
        currentField:
          allOf:
          - $ref: '#/components/schemas/CurrentFieldDataSource'
        significanceEngine:
          allOf:
          - $ref: '#/components/schemas/SignificanceEngineDataSource'
        alert:
          allOf:
          - $ref: '#/components/schemas/AlertDataSource'
        relatedFCRs:
          allOf:
          - $ref: '#/components/schemas/RelatedFCRsDataSource'
        relatedInvestmentManager:
          allOf:
          - $ref: '#/components/schemas/RelatedInvestmentManagerDataSource'
        relatedUnderlyingPrincipalOwner:
          allOf:
          - $ref: '#/components/schemas/RelatedUnderlyingPrincipalOwnerDataSource'
        alertAssessment:
          allOf:
          - $ref: '#/components/schemas/AlertAssessmentDataSource'
        currentProductMetadata:
          allOf:
          - $ref: '#/components/schemas/CurrentProductMetadataDataSource'
        currentUser:
          allOf:
          - $ref: '#/components/schemas/CurrentUserDataSource'
        relatedDocuments:
          allOf:
          - $ref: '#/components/schemas/RelatedDocumentsDataSource'
        screeningMateriality:
          allOf:
          - $ref: '#/components/schemas/ScreeningMaterialityDataSource'
      additionalProperties: false
    AlertDataSource:
      required:
      - attribute
      - source
      - type
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        source:
          type: string
        type:
          type: string
        attribute:
          type: string
      additionalProperties: false
    RelatedInvestmentManagerDataSource:
      required:
      - properties
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    RelatedProductDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        lifecycleStatus:
          type:
          - string
          - 'null'
        relationshipTypes:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
    AutoCreditScreeningDto:
      required:
      - properties
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        creditScreeningOutcome:
          type:
          - string
          - 'null'
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        providerInternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityRoleDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Role of the entity
          example: Client
        version:
          type: integer
          description: "Current version of the Draft where you want to apply your changes. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking"
          format: int32
          default: -1
      additionalProperties: false
      description: Request DTO representing the entity role data
    RelatedAssociationsDataSource:
      required:
      - relatedAssociations
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedAssociations:
          type: array
          items:
            $ref: '#/components/schemas/RelatedAssociationDto'
      additionalProperties: false
    RelatedClientDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
      additionalProperties: false
    CurrentUserDataSource:
      required:
      - teamIds
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        teamIds:
          type: array
          items:
            minLength: 1
            type: string
            format: uuid
        isSystemUser:
          type: boolean
      additionalProperties: false
    CollateralDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
      additionalProperties: false
    EntityCreatedFullRecordDto:
      allOf:
      - $ref: '#/components/schemas/EntityCreatedDto'
      - type: object
        properties:
          role:
            allOf:
            - $ref: '#/components/schemas/EntityRoleDto'
            description: Entity role
          created:
            type:
            - string
            - 'null'
            description: Created date
            format: date-time
            example: '2021-01-01T14:48:00.000Z'
          jurisdiction:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/VersionedJurisdictionDto'
            description: List of jurisdictions entity is in scope for
          associatedJurisdictionsFromParents:
            type:
            - object
            - 'null'
            additionalProperties:
              type:
              - array
              - 'null'
              items:
                $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto'
            description: Associated jurisdictions from parent entities
          evaluatedJurisdictions:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/VersionedJurisdictionDto'
            description: List of evaluated jurisdictions
          version:
            type: integer
            description: Version number for given Entity
            format: int32
            example: 1
          maskedProperties:
            allOf:
            - $ref: '#/components/schemas/MaskedPropertiesDto'
            description: Property name list of sensitive data requirements with masked value
          properties:
            type:
            - object
            - 'null'
            additionalProperties:
              $ref: '#/components/schemas/PropertyDto'
            description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
            example:
              firstName:
                type: Single
                value: Tom
              dateOfBirth:
                type: Single
                value: '2021-07-15'
              address:
                type: Collection
                dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
                collections:
                  54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                    properties:
                      country: Spain
                      city: Madrid
                      street: C. de Sevilla
                  93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                    properties:
                      country: Spain
                      city: Barcelona
                      street: Carrer de Girona
          accessLayers:
            allOf:
            - $ref: '#/components/schemas/AccessLayerDto'
            description: Entity access layers determining the access to the entity
          type:
            type:
            - string
            - 'null'
            description: 'Entity type

              One of Company, Individual, Other, Entity Group'
            example: Company
          alternateId:
            type:
            - string
            - 'null'
            description: Id from external system to migrate data
            example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        additionalProperties: false
      description: Response DTO representing created entity
    RelatedDealsDataSource:
      required:
      - relatedDeals
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedDeals:
          type: array
          items:
            $ref: '#/components/schemas/RelatedDealDto'
      additionalProperties: false
    CreateUrlToUploadFileRequestDto:
      type: object
      properties:
        fileName:
          type:
          - string
          - 'null'
          description: File name
          example: file.png
        dataKey:
          type:
          - string
          - 'null'
          description: Requirement dataKey
          example: richTextEditorV1
        isRootContent:
          type: boolean
          description: Identifier if it's requirement content
        entityDraftId:
          type: string
          description: Entity Draft Id
          format: uuid
          example: 2124efd2-3423-40f5-9bdb-fae66c7fa88a
        contentSize:
          type: integer
          description: File content size
          format: int64
          example: 6892
      additionalProperties: false
    CurrentProductMetadataDataSource:
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        isAgency:
          type:
          - string
          - 'null'
        lifecycleStatus:
          type:
          - string
          - 'null'
      additionalProperties: false
    SinglePropertyDto2:
      type: object
      properties:
        value:
          type:
          - string
          - 'null'
        valueId:
          type:
          - string
          - 'null'
      additionalProperties: false
    ScreeningMaterialityAssessmentDto:
      required:
      - adverseMediaJurisdictions
      - enforcementsJurisdictions
      - otherJurisdictions
      - pepJurisdictions
      - sanctionsJurisdictions
      type: object
      properties:
        mainEntity:
          type: boolean
        materialityOutcome:
          type:
          - string
          - 'null'
        pepMaterialityStatus:
          type:
          - string
          - 'null'
        sanctionsMaterialityStatus:
          type:
          - string
          - 'null'
        adverseMediaMaterialityStatus:
          type:
          - string
          - 'null'
        enforcementsMaterialityStatus:
          type:
          - string
          - 'null'
        otherMaterialityStatus:
          type:
          - string
          - 'null'
        pepJurisdictions:
          type: array
          items:
            type: string
        sanctionsJurisdictions:
          type: array
          items:
            type: string
        adverseMediaJurisdictions:
          type: array
          items:
            type: string
        enforcementsJurisdictions:
          type: array
          items:
            type: string
        otherJurisdictions:
          type: array
          items:
            type: string
        sanctionsProceedDecision:
          type:
          - string
          - 'null'
      additionalProperties: false
    EventIngressDataSource:
      required:
      - eventSubtype
      - eventType
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        eventType:
          minLength: 1
          type: string
        eventSubtype:
          minLength: 1
          type: string
      additionalProperties: false
    CreateEntityRequestV2Dto:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: 'Entity type

            One of Company, Individual, Other, Entity Group'
          example: Individual
        targetEntity:
          type:
          - string
          - 'null'
          description: 'Target Entity type

            One of Client, Related Party'
          example: Related Party
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        dataSources:
          allOf:
          - $ref: '#/components/schemas/DataSourcesDto'
          description: Additional data sources used for evaluation
        policyJurisdiction:
          type:
          - string
          - 'null'
          description: Policy jurisdiction
          example: Global
          deprecated: true
        policyJurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of policy jurisdictions e.g. ["Global", "Ireland"]
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        category:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of requirement category e.g. ["Basic Details", "Enrich Details"]
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto'
          description: Entity access layers determining the access to the entity
      additionalProperties: false
      description: Request DTO to create new entity
    ChangedFieldDto:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedPartiesDataSource:
      required:
      - relatedParties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        relatedParties:
          type: array
          items:
            $ref: '#/components/schemas/RelatedPartyDto'
      additionalProperties: false
    AssociatedVersionedJurisdictionDto:
      allOf:
      - $ref: '#/components/schemas/VersionedJurisdictionDto'
      - type: object
        properties:
          isOffboarded:
            type: boolean
            description: Flag to determine if previously associated jurisdiction is now offboarded
            example: false
        additionalProperties: false
    InvestmentAccountRelatedFundShareClassDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    AlertAssessmentDataSource:
      required:
      - assessments
      - lastAssessment
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        assessments:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/AlertAssessmentDto'
        lastAssessment:
          allOf:
          - $ref: '#/components/schemas/AlertAssessmentDto'
        lastAssessmentOutcome:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityCreatedDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the created entity
          format: uuid
          example: e1809731-77df-4e72-98e7-0d314b7a5151
      additionalProperties: false
      description: Response DTO representing created entity
    PropertiesDto:
      type: object
      properties:
        singleProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SinglePropertyDto2'
        collectionProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CollectionPropertyDto2'
        customProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/CustomPropertyDto2'
      additionalProperties: false
    CurrentJourneysDataSource:
      required:
      - inProgressJourneyTypes
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        inProgressJourneyTypes:
          type: array
          items:
            type: string
      additionalProperties: false
    SignificanceEngineDto:
      type: object
      properties:
        singleFields:
          type:
          - array
          - 'null'
          items:
            type: string
        collections:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              type: array
              items:
                type: string
      additionalProperties: false
    RelatedUnderlyingPrincipalOwnerDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    ManualCreditAssessmentV2DataSource:
      required:
      - creditAssessments
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditAssessments:
          type: array
          items:
            $ref: '#/components/schemas/CreditAssessmentDto'
      additionalProperties: false
    RelatedFCRsDataSource:
      required:
      - fcRs
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        fcRs:
          type: array
          items:
            $ref: '#/components/schemas/RelatedFCRDto'
      additionalProperties: false
    AlertAssessmentDto:
      required:
      - category
      type: object
      properties:
        category:
          type: string
      additionalProperties: false
    AccountRelatedFundDto:
      required:
      - properties
      type: object
      properties:
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    ReviewAndApprovalDataSource:
      required:
      - reviewAndApprovals
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        reviewAndApprovals:
          type: array
          items:
            $ref: '#/components/schemas/ReviewAndApprovalDto'
      additionalProperties: false
    CreditAssessmentDto:
      required:
      - properties
      - taskId
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        assessmentOutcome:
          type:
          - string
          - 'null'
        assessmentComment:
          type:
          - string
          - 'null'
        taskId:
          type: string
        taskDataKey:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedDocumentDto:
      required:
      - document
      type: object
      properties:
        document:
          allOf:
          - $ref: '#/components/schemas/RelatedDocumentVersionedDto'
      additionalProperties: false
    CollateralDataSource:
      required:
      - collaterals
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        collaterals:
          type: array
          items:
            $ref: '#/components/schemas/CollateralDto'
      additionalProperties: false
    RelatedDealDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
      additionalProperties: false
    RelatedAssociationDto:
      required:
      - properties
      type: object
      properties:
        associationType:
          type:
          - string
          - 'null'
        ownershipPercentage:
          type:
          - number
          - 'null'
          format: double
        associationToClient:
          type:
          - string
          - 'null'
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
      additionalProperties: false
    AutoCreditAssessmentDto:
      required:
      - properties
      type: object
      properties:
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        assessmentOutcome:
          type:
          - string
          - 'null'
        providerInternalIdentifier:
          type:
          - string
          - 'null'
      additionalProperties: false
    RelatedProductsDataSource:
      required:
      - products
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        products:
          type: array
          items:
            $ref: '#/components/schemas/RelatedProductDto'
      additionalProperties: false
    AccountRelatedFundsDataSource:
      required:
      - accountRelatedFunds
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        accountRelatedFunds:
          type: array
          items:
            $ref: '#/components/schemas/AccountRelatedFundDto'
      additionalProperties: false
    CurrentProductDataSource:
      required:
      - properties
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto'
          description: It's a generic property and needs to be replaced with one of `SinglePropertyDto` or `CollectionPropertyDto`If the field does not exist inside defined policy then it will not be saved.
          example:
            firstName:
              type: Single
              value: Tom
            dateOfBirth:
              type: Single
              value: '2021-07-15'
            address:
              type: Collection
              dataGroupId: 674ccef1-cfdc-46af-97f8-340b24ab7f43
              collections:
                54a25d24-1a4b-45c6-a5b4-980e5d3a1df5:
                  properties:
                    country: Spain
                    city: Madrid
                    street: C. de Sevilla
                93468632-1a9e-4ad0-b2e1-c5ec0f65d7b2:
                  properties:
                    country: Spain
                    city: Barcelona
                    street: Carrer de Girona
        lifecycleStatus:
          type:
          - string
          - 'null'
      additionalProperties: false
    AccessLayerDetailsDto:
      type: object
      properties:
        dataKey:
          type:
          - string
          - 'null'
          description: Access layer data key
          example: Global
        inheritedFrom:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: List of entity ids that access layer is inherited from
        isInherited:
          type: boolean
          description: Flag indicating if access layer is inherited by default
      additionalProperties: false
    ManualCreditScreeningDataSource:
      required:
      - creditScreenings
      type: object
      properties:
        dataSource:
          type:
          - string
          - 'null'
          readOnly: true
        creditScreenings:
          type: array
          items:
            $ref: '#/components/schemas/ManualCreditScreeningDto'
        relatedPartyCreditScreenings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ManualCreditScreeningDto'
      additionalProperties: false
    CreateEntityRequestV2DtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/CreateEntityRequestV2Dto'
          description: Request DTO to create new entity
      additionalProperties: false
    PropertyType:
      enum:
      - Single
      - Custom
      - Collection
      type: string
    EntityRiskDto:
      type: object
      properties:
        riskCategory:
          type:
          - string
          - 'null'
          description: Risk category
          example: Low
        riskLevel:
          type:
          - number
          - 'null'
          description: Risk level
          format: double
          example: 1
      additionalProperties: false
      description: Response DTO representing the entity risk data
    MultiSearchForDuplicatesDto:
      type: object
      properties:
        searchForDuplicatesDict:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SearchForDuplicatesDto'
          description: Dictionary of search of entity duplicates criteria
      additionalProperties: false
      description: Request DTO to multi-search for entity duplicates
    GetPreSignUrlsRequestDto:
      type: object
      properties:
        isRootContent:
          type: boolean
        dataKey:
          type:
          - string
          - 'null'
        fileIdentifiers:
          type:
          - array
          - 'null'
          items:
            type: string
        entityDraftId:
          type:
          - string
          - 'null'
          format: uuid
      additionalProperties: false
    EntityQueryPagedDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityQueryPagedDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    SearchForDuplicatesDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchForDuplicatesDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EntityQueryPagedDto:
      type: object
      properties:
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_2'
          description: Specification of search result page
        searchAfter:
          type:
          - string
          - 'null'
          description: Search after parameter
          example: '2020-12-28T16:45:53'
        attributes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of entity attributes to fetch the data for
          deprecated: true
      additionalProperties: false
      description: Request DTO to query for a paged list of entities
    AccessLayerDto_2:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
        geographicDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of geographic access layers with details about inheritance
        businessRelatedDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of business related access layers with details about inheritance
      additionalProperties: false
      description: Response DTO representing associated access layers
    PropertyDto_2:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Property is not used in generated models. We need it to deserialize correctly to specific type in generated DotNet Client.
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of properties.
          readOnly: true
      additionalProperties: false
      description: Abstraction that represents properties
      discriminator:
        propertyName: discriminator
        mapping:
          Collection: '#/components/schemas/CollectionPropertyDto'
          Custom: '#/components/schemas/CustomPropertyDto'
          Single: '#/components/schemas/SinglePropertyDto'
    GetReportPreSignUrlRequestDto:
      type: object
      properties:
        reportType:
          type:
          - string
          - 'null'
      additionalProperties: false
    EntityQueryDto:
      type: object
      properties:
        ids:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of entity ids to fetch
        attributes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of entity attributes to fetch the data for
          deprecated: true
      additionalProperties: false
      description: Request DTO to query for a list of entities
    MultiSearchForDuplicatesDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/MultiSearchForDuplicatesDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EntityRoleDto_2:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Role of the entity
          example: Client
      additionalProperties: false
      description: Response DTO representing the entity role data
    EntityDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityDto_3'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    LifecycleStatusDto:
      enum:
      - Unknown
      - OnboardingInProgress
      - MaintenanceInProgress
      - Compliant
      - ReviewInProgress
      - PendingOffboarding
      - ClientOffboarded
      type: string
    EntityDtoServiceResponse_3:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityDto_3'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    AdvancedSearchPropertyDto:
      type: object
      properties:
        propertyType:
          type:
          - string
          - 'null'
          description: Property type.
          example: Single
        value:
          type:
          - string
          - 'null'
          description: The value.
          example: Tom
        boost:
          type:
          - number
          - 'null'
          description: Elastic Search Boost
          format: double
          example: 100
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/AdvancedSearchPropertyDto'
          description: Nested properties to search by.
          example:
            firstName:
              value: Tom
              boost: 20
            numberOfDependents:
              value: '30'
              boost: 20
      additionalProperties: false
    AdvancedSearchFileResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/AdvancedSearchFileResultDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringSearchEntityDtoListDictionaryServiceResponse:
      type: object
      properties:
        data:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/SearchEntityDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    AdvancedSearchFileResultDto:
      type: object
      properties:
        searchResultFileUrl:
          type:
          - string
          - 'null'
          description: Search result file URL
          example: https://fenergo.com/report.csv
        count:
          type: integer
          description: Items count
          format: int32
          example: 23
      additionalProperties: false
      description: Response representing file search result
    EntityQueryDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityQueryDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    EntitySearchByNameDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntitySearchByNameDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    SearchForDuplicatesDto:
      required:
      - type
      type: object
      properties:
        type:
          minLength: 1
          type: string
          description: Entity type
          example: Individual
        excludeRole:
          type:
          - string
          - 'null'
          description: Entity role to be excluded, if any
          example: Client
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Entity properties to check for duplicates
        dataGroupProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              type: string
          description: 'Data group properties to check for duplicates.

            Outer key is the collection name (data group), inner key is the field name, value is the search value.'
          example:
            taxIdentifiers:
              taxId: '123456'
              taxCountry: IE
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_2'
          description: Specification of search result page
      additionalProperties: false
      description: Request DTO to query for entity duplicates
    GetPreSignUrlsResponseDto:
      type: object
      properties:
        isRootContent:
          type: boolean
        urls:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
      additionalProperties: false
    EntitySnapshotDtoIEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntitySnapshotDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    AdvancedSearchResultDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/AdvancedSearchResultDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SearchEntityDto:
      type: object
      properties:
        id:
          type: string
          description: Entity id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        type:
          type:
          - string
          - 'null'
          description: Entity type
          example: Individual
        risk:
          allOf:
          - $ref: '#/components/schemas/EntityRiskDto'
          description: Entity risk
        lifecycleStatus:
          allOf:
          - $ref: '#/components/schemas/LifecycleStatusDto'
          description: Lifecycle status
          example: OnboardingInProgress
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Entity access layers determining the access to the entity
        inScopeJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_2'
          description: List of jurisdictions entity is in scope for
        offboardedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OffboardedJurisdictionDto'
          description: List of offboarded jurisdictions
        evaluatedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_2'
          description: List of evaluated jurisdictions
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: A Shared Data Template used on Groups
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto_2'
          description: Entity properties
        associatedJurisdictionsFromParents:
          type:
          - object
          - 'null'
          additionalProperties:
            uniqueItems: true
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_2'
          description: Associated jurisdictions from parent entities
        status:
          allOf:
          - $ref: '#/components/schemas/EntityStatus'
          description: Entity status
          deprecated: true
        userId:
          type:
          - string
          - 'null'
          description: 'User id

            Deprecated - not to use in new code'
          deprecated: true
        journeys:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityJourneyDto'
          description: 'List of Journeys for given entity

            Deprecated - not to use in new code'
          deprecated: true
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_2'
          description: Entity role
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
      additionalProperties: false
      description: Response DTO representing entity data
    SearchEntityDtoListServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchEntityDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    EntityAdvancedSearchFileDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityAdvancedSearchFileDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    ServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    PagerDto_2:
      type: object
      properties:
        size:
          maximum: 100
          minimum: 0
          type: integer
          description: Size of the page (result set)
          format: int32
          example: 5
        from:
          minimum: 0
          type: integer
          description: Position for the search results to start
          format: int32
          example: 0
        sortBy:
          type:
          - string
          - 'null'
          description: Column to sort by
          example: created
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder_2'
          description: Sort Order (Ascending or Descending)
      additionalProperties: false
      description: Specification of search result page
    PropertyDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PropertyDto_2'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SortOrder_2:
      enum:
      - 0
      - 1
      type: integer
      description: Sort Order (Ascending or Descending)
      format: int32
    EntityJourneyDto:
      type: object
      properties:
        journeyType:
          type:
          - string
          - 'null'
          description: Type of Journey
          example: Client Onboarding
        journeyId:
          type: string
          description: Journey id
          format: uuid
          example: e51b9087-7565-4d8d-864d-fa57177a8bea
        journeyStatus:
          type:
          - string
          - 'null'
          description: Entity status
          example: In Progress
      additionalProperties: false
      description: Response DTO representing entity journey data
    GetReportPreSignUrlRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetReportPreSignUrlRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    GetReportPreSignUrlResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetReportPreSignUrlResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          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 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_2'
          description: Entity properties
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_2'
          description: Entity role
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Entity access layers determining the access to the entity
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: Entity shared data template id that determines this entities shared data template
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
      additionalProperties: false
      description: Response DTO representing core entity data at a specific time
    SharedDataTemplateDto:
      type: object
      properties:
        sharedDataTemplateId:
          type: string
          description: The Shared Data Template Id
          format: uuid
        versionNumber:
          type: integer
          description: The version of the shared data template linked to the entity
          format: int32
      additionalProperties: false
      description: Request DTO to query for a shared data template linked to an entity group
    GetPreSignUrlsResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetPreSignUrlsResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    GetPreSignUrlsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetPreSignUrlsRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    VersionedJurisdictionDto_2:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
      additionalProperties: false
    EntityAdvancedSearchDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityAdvancedSearchDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    ValidationErrorModelListServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel_2'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    ObjectServiceResponse_2:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    EntityDto_3:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          type: string
        id:
          type: string
          description: 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_2'
          description: Entity properties
        risk:
          allOf:
          - $ref: '#/components/schemas/EntityRiskDto'
          description: Entity risk
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_2'
          description: Entity role
        status:
          allOf:
          - $ref: '#/components/schemas/EntityStatus'
          description: Entity status
          deprecated: true
        lifecycleStatus:
          allOf:
          - $ref: '#/components/schemas/LifecycleStatusDto'
          description: Lifecycle status
          example: OnboardingInProgress
        userId:
          type:
          - string
          - 'null'
          description: 'User id

            Deprecated - not to use in new code'
          deprecated: true
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        journeys:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityJourneyDto'
          description: List of Journeys for given entity
          deprecated: true
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_2'
          description: Entity access layers determining the access to the entity
        inScopeJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_2'
          description: List of jurisdictions entity is in scope for
        offboardedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OffboardedJurisdictionDto'
          description: List of offboarded jurisdictions
        associatedJurisdictionsFromParents:
          type:
          - object
          - 'null'
          additionalProperties:
            uniqueItems: true
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_2'
          description: Associated jurisdictions from parent entities
        evaluatedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_2'
          description: List of evaluated jurisdictions
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
        propertiesVersion:
          type: integer
          description: Current version of the properties which increments on each merge of a draft
          format: int32
          example: 5
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: A Shared Data Template used on Groups
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
      additionalProperties: false
      description: Response DTO representing entity data
      discriminator:
        propertyName: discriminator
        mapping:
          EntityDto: '#/components/schemas/EntityDto'
          ExtendedEntityDto: '#/components/schemas/ExtendedEntityDto'
    AdvancedSearchResultDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchEntityDto'
          description: Items for the current page.
        totalItems:
          type: integer
          description: Total count of items.
          format: int64
          example: 1
      additionalProperties: false
      description: Response DTO representing advanced search result
    EntitySearchByNameDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Entity name for search
          example: Test
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_2'
          description: Specification of search result page
      additionalProperties: false
      description: Request DTO to query for a list of entities by name
    EntityAdvancedSearchDto:
      required:
      - discriminator
      - pager
      - properties
      - type
      type: object
      properties:
        discriminator:
          type: string
        minScore:
          type:
          - number
          - 'null'
          description: Elastic Search Min score to match
          format: double
          example: 10
        type:
          minLength: 1
          type: string
          description: Entity type
          example: Individual
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_2'
          description: Specification of search result page
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AdvancedSearchPropertyDto'
          description: Entity properties to check for duplicates
          example:
            firstName:
              value: Tom
              boost: 20
            numberOfDependents:
              value: '30'
              boost: 20
      additionalProperties: false
      description: Request DTO to query for entity duplicates
      discriminator:
        propertyName: discriminator
        mapping:
          EntityAdvancedSearchDto: '#/components/schemas/EntityAdvancedSearchDto'
          EntityAdvancedSearchInEntityIdsDto: '#/components/schemas/EntityAdvancedSearchInEntityIdsDto'
    ValidationErrorModel_2:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property
          example: data
        errorMessage:
          type:
          - string
          - 'null'
          description: User friendly error message
          example: Data is required
        attemptedValue:
          description: Invalid value
        errorCode:
          type:
          - string
          - 'null'
          description: Internal error code
          example: NotNullValidator
      additionalProperties: false
      description: Represents the details of validation error
    OffboardedJurisdictionDto:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Offboarded jurisdiction
          example: Canada
        offboardedOn:
          type: string
          description: Date when jurisdiction was offboarded
          format: date-time
          example: '2022-04-01T14:48:00.000Z'
      additionalProperties: false
      description: Response DTO representing offboarded jurisdiction
    AssociatedVersionedJurisdictionDto_2:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
        isOffboarded:
          type: boolean
          description: Flag to determine if previously associated jurisdiction is now offboarded
          example: false
      additionalProperties: false
    EntityStatus:
      enum:
      - 0
      - 1
      type: integer
      format: int32
    EntityAdvancedSearchFileDto:
      type: object
      properties:
        minScore:
          type:
          - number
          - 'null'
          description: Elastic Search Min score to match
          format: double
          example: 10
        type:
          type:
          - string
          - 'null'
          description: Entity type
          example: Individual
        totalItems:
          type: integer
          description: Total items to get
          format: int32
          example: 20
        headers:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Headers visible in the file
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/AdvancedSearchPropertyDto'
          description: Filters based on property values
          example:
            firstName:
              value: Tom
              boost: 20
            numberOfDependents:
              value: '30'
              boost: 20
      additionalProperties: false
      description: Request DTO to query for entity duplicates
    ServiceResponseMessage_2:
      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
    EntitySnapshotDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntitySnapshotDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_2'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    GetReportPreSignUrlResponseDto:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    ConflictsExistReponseDto:
      type: object
      properties:
        conflictsExist:
          type: boolean
      additionalProperties: false
    EntitySnapshotDtoIEnumerableServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntitySnapshotDto_2'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ServiceResponse_3:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SortOrder_3:
      enum:
      - 0
      - 1
      type: integer
      description: Sort Order (Ascending or Descending)
      format: int32
    SearchByIdsRequestDto:
      type: object
      properties:
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_3'
          description: Specification of search result page
        entityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
          description: The list of entity IDs to search for.
        propertyNames:
          type:
          - array
          - 'null'
          items:
            type: string
          description: "The list of property names to retrieve for each entity. \nIf empty or null, all properties will be returned."
        omitNameFieldsFromProps:
          type: boolean
          description: If true, removes fields like firstName, lastName, legalEntityName, groupName from Properties.
      additionalProperties: false
      description: Represents a request for searching entities by their IDs with optional pagination and property filtering.
    GetEntityDraftsLightRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetEntityDraftsLightRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    GetReportPreSignUrlResponseDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetReportPreSignUrlResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SearchEntityDtoPagedListDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchEntityDto_2'
          description: List of items returned by the query
        total:
          type: integer
          description: Number of total items matched by the query
          format: int64
      additionalProperties: false
    EntityAdvancedSearchDto_2:
      required:
      - discriminator
      - pager
      - properties
      - type
      type: object
      properties:
        discriminator:
          type: string
        minScore:
          type:
          - number
          - 'null'
          description: Elastic Search Min score to match
          format: double
          example: 10
        type:
          minLength: 1
          type: string
          description: Entity type
          example: Individual
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_3'
          description: Specification of search result page
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AdvancedSearchPropertyDto'
          description: Entity properties to check for duplicates
          example:
            firstName:
              value: Tom
              boost: 20
            numberOfDependents:
              value: '30'
              boost: 20
      additionalProperties: false
      description: Request DTO to query for entity duplicates
      discriminator:
        propertyName: discriminator
        mapping:
          EntityAdvancedSearchDto: '#/components/schemas/EntityAdvancedSearchDto'
          EntityAdvancedSearchInEntityIdsDto: '#/components/schemas/EntityAdvancedSearchInEntityIdsDto'
    ValidationErrorModel_3:
      type: object
      properties:
        propertyName:
          type:
          - string
          - 'null'
          description: Name of the property
          example: data
        errorMessage:
          type:
          - string
          - 'null'
          description: User friendly error message
          example: Data is required
        attemptedValue:
          description: Invalid value
        errorCode:
          type:
          - string
          - 'null'
          description: Internal error code
          example: NotNullValidator
      additionalProperties: false
      description: Represents the details of validation error
    EntityQueryPagedDto_2:
      type: object
      properties:
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_3'
          description: Specification of search result page
        searchAfter:
          type:
          - string
          - 'null'
          description: Search after parameter
          example: '2020-12-28T16:45:53'
        attributes:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of entity attributes to fetch the data for
          deprecated: true
      additionalProperties: false
      description: Request DTO to query for a paged list of entities
    AccessLayerDto_3:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
        geographicDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of geographic access layers with details about inheritance
        businessRelatedDetails:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AccessLayerDetailsDto'
          description: Collection of business related access layers with details about inheritance
      additionalProperties: false
      description: Response DTO representing associated access layers
    PropertyDto_3:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Property is not used in generated models. We need it to deserialize correctly to specific type in generated DotNet Client.
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of properties.
          readOnly: true
      additionalProperties: false
      description: Abstraction that represents properties
      discriminator:
        propertyName: discriminator
        mapping:
          Collection: '#/components/schemas/CollectionPropertyDto'
          Custom: '#/components/schemas/CustomPropertyDto'
          Single: '#/components/schemas/SinglePropertyDto'
    SearchByIdsEntityResponseDto:
      type: object
      properties:
        entityId:
          type: string
          description: Gets or sets the unique identifier of the entity.
          format: uuid
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
          description: Gets or sets the collection of properties associated with the entity.
        type:
          type:
          - string
          - 'null'
          description: Gets or sets the type of the entity.
        entityName:
          type:
          - string
          - 'null'
          description: Gets or sets the entity name.
      additionalProperties: false
      description: Represents the result of a search by entity Ids, containing the entity's details and properties.
    UnauthorizedEntityDto:
      type: object
      properties:
        id:
          type: string
          description: Entity id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        name:
          type:
          - string
          - 'null'
          description: Name of the entity
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/SimpleAccessLayerDto'
          description: Entity access layers determining the access to the entity
        type:
          type:
          - string
          - 'null'
          description: Type of the entity
        lifecycleStatus:
          allOf:
          - $ref: '#/components/schemas/LifecycleStatusDto'
          description: Lifecycle status
          example: OnboardingInProgress
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
        propertiesVersion:
          type: integer
          description: Current version of the properties which increments on each merge of a draft
          format: int32
          example: 5
      additionalProperties: false
    GetEntityDraftsLightRequestDto:
      type: object
      properties:
        journeyId:
          type: string
          format: uuid
        entityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
      additionalProperties: false
      description: Request DTO representing entity drafts Ids and Names
    SearchForDuplicatesDto_2:
      required:
      - type
      type: object
      properties:
        type:
          minLength: 1
          type: string
          description: Entity type
          example: Individual
        excludeRole:
          type:
          - string
          - 'null'
          description: Entity role to be excluded, if any
          example: Client
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Entity properties to check for duplicates
        dataGroupProperties:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              type: string
          description: 'Data group properties to check for duplicates.

            Outer key is the collection name (data group), inner key is the field name, value is the search value.'
          example:
            taxIdentifiers:
              taxId: '123456'
              taxCountry: IE
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_3'
          description: Specification of search result page
      additionalProperties: false
      description: Request DTO to query for entity duplicates
    SearchEntityDto_2:
      type: object
      properties:
        id:
          type: string
          description: Entity id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        type:
          type:
          - string
          - 'null'
          description: Entity type
          example: Individual
        risk:
          allOf:
          - $ref: '#/components/schemas/EntityRiskDto'
          description: Entity risk
        lifecycleStatus:
          allOf:
          - $ref: '#/components/schemas/LifecycleStatusDto'
          description: Lifecycle status
          example: OnboardingInProgress
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_3'
          description: Entity access layers determining the access to the entity
        inScopeJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: List of jurisdictions entity is in scope for
        offboardedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OffboardedJurisdictionDto'
          description: List of offboarded jurisdictions
        evaluatedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: List of evaluated jurisdictions
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: A Shared Data Template used on Groups
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
        properties:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/PropertyDto_3'
          description: Entity properties
        associatedJurisdictionsFromParents:
          type:
          - object
          - 'null'
          additionalProperties:
            uniqueItems: true
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_3'
          description: Associated jurisdictions from parent entities
        status:
          allOf:
          - $ref: '#/components/schemas/EntityStatus'
          description: Entity status
          deprecated: true
        userId:
          type:
          - string
          - 'null'
          description: 'User id

            Deprecated - not to use in new code'
          deprecated: true
        journeys:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityJourneyDto'
          description: 'List of Journeys for given entity

            Deprecated - not to use in new code'
          deprecated: true
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_3'
          description: Entity role
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
      additionalProperties: false
      description: Response DTO representing entity data
    AdvancedSearchResultDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/AdvancedSearchResultDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SearchEntityDtoListServiceResponse_2:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchEntityDto_2'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    PagerDto_3:
      type: object
      properties:
        size:
          maximum: 100
          minimum: 0
          type: integer
          description: Size of the page (result set)
          format: int32
          example: 5
        from:
          minimum: 0
          type: integer
          description: Position for the search results to start
          format: int32
          example: 0
        sortBy:
          type:
          - string
          - 'null'
          description: Column to sort by
          example: created
        sortOrder:
          allOf:
          - $ref: '#/components/schemas/SortOrder_3'
          description: Sort Order (Ascending or Descending)
      additionalProperties: false
      description: Specification of search result page
    AuthorizedEntityDto:
      type: object
      properties:
        id:
          type: string
          description: Entity id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        type:
          type:
          - string
          - 'null'
          description: Entity type
          example: Individual
        properties:
          allOf:
          - $ref: '#/components/schemas/PropertiesDto'
          description: Entity properties
        risk:
          allOf:
          - $ref: '#/components/schemas/EntityRiskDto'
          description: Entity risk
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_3'
          description: Entity role
        lifecycleStatus:
          allOf:
          - $ref: '#/components/schemas/LifecycleStatusDto'
          description: Lifecycle status
          example: OnboardingInProgress
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_3'
          description: Entity access layers determining the access to the entity
        inScopeJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: List of jurisdictions entity is in scope for
        offboardedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OffboardedJurisdictionDto'
          description: List of offboarded jurisdictions
        associatedJurisdictionsFromParents:
          type:
          - object
          - 'null'
          additionalProperties:
            uniqueItems: true
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_3'
          description: Associated jurisdictions from parent entities
        evaluatedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: List of evaluated jurisdictions
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: A Shared Data Template used on Groups
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
        propertiesVersion:
          type: integer
          description: Current version of the properties which increments on each merge of a draft
          format: int32
          example: 5
      additionalProperties: false
      description: Response DTO representing entity data
    EntityNamesDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityWithNameDto'
          description: List of EntityWithNameDto
      additionalProperties: false
      description: Entity names DTO
    GetPreSignUrlsResponseDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetPreSignUrlsResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    GetEntityDraftsLightDto:
      type: object
      properties:
        entityId:
          type: string
          format: uuid
        entityDraftId:
          type: string
          format: uuid
        entityName:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Request DTO representing entity drafts Id and Names
    SearchByIdsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchByIdsRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    VersionedJurisdictionDto_3:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
      additionalProperties: false
    EntityDto_4:
      required:
      - discriminator
      type: object
      properties:
        discriminator:
          type: string
        id:
          type: string
          description: 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_3'
          description: Entity properties
        risk:
          allOf:
          - $ref: '#/components/schemas/EntityRiskDto'
          description: Entity risk
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_3'
          description: Entity role
        status:
          allOf:
          - $ref: '#/components/schemas/EntityStatus'
          description: Entity status
          deprecated: true
        lifecycleStatus:
          allOf:
          - $ref: '#/components/schemas/LifecycleStatusDto'
          description: Lifecycle status
          example: OnboardingInProgress
        userId:
          type:
          - string
          - 'null'
          description: 'User id

            Deprecated - not to use in new code'
          deprecated: true
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        alternateId:
          type:
          - string
          - 'null'
          description: Id from external system to migrate data
          example: 1124efd2-3423-40f5-9bdb-fae66c7fa88a
        journeys:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityJourneyDto'
          description: List of Journeys for given entity
          deprecated: true
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_3'
          description: Entity access layers determining the access to the entity
        inScopeJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: List of jurisdictions entity is in scope for
        offboardedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OffboardedJurisdictionDto'
          description: List of offboarded jurisdictions
        associatedJurisdictionsFromParents:
          type:
          - object
          - 'null'
          additionalProperties:
            uniqueItems: true
            type:
            - array
            - 'null'
            items:
              $ref: '#/components/schemas/AssociatedVersionedJurisdictionDto_3'
          description: Associated jurisdictions from parent entities
        evaluatedJurisdictions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/VersionedJurisdictionDto_3'
          description: List of evaluated jurisdictions
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
        propertiesVersion:
          type: integer
          description: Current version of the properties which increments on each merge of a draft
          format: int32
          example: 5
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: A Shared Data Template used on Groups
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
      additionalProperties: false
      description: Response DTO representing entity data
      discriminator:
        propertyName: discriminator
        mapping:
          EntityDto: '#/components/schemas/EntityDto'
          ExtendedEntityDto: '#/components/schemas/ExtendedEntityDto'
    GetEntityDraftsLightResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetEntityDraftsLightResponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    GetEntitiesListV2ResponseServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetEntitiesListV2Response'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SimpleAccessLayerDto:
      type: object
      properties:
        geographic:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of geographic access layers
        businessRelated:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Collection of business related access layers
      additionalProperties: false
    EntityRoleDto_3:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Role of the entity
          example: Client
      additionalProperties: false
      description: Response DTO representing the entity role data
    EntityDtoServiceResponse_4:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityDto_4'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    AdvancedSearchFileResultDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/AdvancedSearchFileResultDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ConflictsExistReponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ConflictsExistReponseDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SearchByIdsEntityResponseDtoPagedListDto:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SearchByIdsEntityResponseDto'
          description: List of items returned by the query
        total:
          type: integer
          description: Number of total items matched by the query
          format: int64
      additionalProperties: false
    SearchByIdsEntityResponseDtoPagedListDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchByIdsEntityResponseDtoPagedListDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringSearchEntityDtoPagedListDtoDictionaryServiceResponse:
      type: object
      properties:
        data:
          type:
          - object
          - 'null'
          additionalProperties:
            $ref: '#/components/schemas/SearchEntityDtoPagedListDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    EntitySnapshotDto_2:
      type: object
      properties:
        id:
          type: string
          description: 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_3'
          description: Entity properties
        role:
          allOf:
          - $ref: '#/components/schemas/EntityRoleDto_3'
          description: Entity role
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        deleted:
          type:
          - string
          - 'null'
          description: Deleted date
          format: date-time
          example: '2021-01-01T14:48:00.000Z'
        accessLayers:
          allOf:
          - $ref: '#/components/schemas/AccessLayerDto_3'
          description: Entity access layers determining the access to the entity
        sharedDataTemplate:
          allOf:
          - $ref: '#/components/schemas/SharedDataTemplateDto'
          description: Entity shared data template id that determines this entities shared data template
        maskedProperties:
          allOf:
          - $ref: '#/components/schemas/MaskedPropertiesDto'
          description: Property name list of sensitive data requirements with masked value
      additionalProperties: false
      description: Response DTO representing core entity data at a specific time
    EntityWithNameDto:
      type: object
      properties:
        id:
          type: string
          description: Entity id
          format: uuid
          example: 8d631fde-505e-4101-a7cd-83ab6c054a5a
        type:
          type:
          - string
          - 'null'
          description: Entity type
          example: Company
        name:
          type:
          - string
          - 'null'
          description: Name of the entity
        version:
          type: integer
          description: Version number for given Entity
          format: int32
          example: 1
      additionalProperties: false
    ValidationErrorModelListServiceResponse_3:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ValidationErrorModel_3'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
      example:
        data:
        - propertyName: data
          errorMessage: Data is required
          attemptedValue: ''
          errorCode: NotNullValidator
        messages:
        - message: Data is required
          type: Error
          errorCode: Error Code
    GetEntityNamesByIdsRequestDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetEntityNamesByIdsRequestDto'
          description: The service request DTO
      additionalProperties: false
      description: Service request data
    AssociatedVersionedJurisdictionDto_3:
      type: object
      properties:
        jurisdiction:
          type:
          - string
          - 'null'
          description: Jurisdiction Name
          example: Global
        versionId:
          type: string
          description: Jurisdiction Version Id
          format: uuid
          example: 7c4bc3ff-9d5b-4ccd-839b-637c227b1c65
        isOffboarded:
          type: boolean
          description: Flag to determine if previously associated jurisdiction is now offboarded
          example: false
      additionalProperties: false
    ServiceResponseMessage_3:
      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
    GetEntityNamesByIdsRequestDto:
      type: object
      properties:
        entityIds:
          type:
          - array
          - 'null'
          items:
            type: string
            format: uuid
      additionalProperties: false
    GetEntityDraftsLightResponseDto:
      type: object
      properties:
        lightEntityDrafts:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/GetEntityDraftsLightDto'
      additionalProperties: false
      description: Request DTO representing entity drafts Ids and Names
    GetEntitiesListV2Response:
      type: object
      properties:
        accessibleEntities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AuthorizedEntityDto'
          description: List of entities that the user has full access to
        inaccessibleEntities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/UnauthorizedEntityDto'
          description: List of entities that the user has limited access to
      additionalProperties: false
    EntityNamesDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntityNamesDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    PropertyDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/PropertyDto_3'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    SearchEntityDtoPagedListDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/SearchEntityDtoPagedListDto'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ObjectServiceResponse_3:
      type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    StringServiceResponse_3:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    EntitySearchByNameDto_2:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Entity name for search
          example: Test
        pager:
          allOf:
          - $ref: '#/components/schemas/PagerDto_3'
          description: Specification of search result page
      additionalProperties: false
      description: Request DTO to query for a list of entities by name
    EntitySnapshotDtoServiceResponse_2:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntitySnapshotDto_2'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage_3'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    EntitiesCreatedDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntitiesCreatedDto'
          description: Represents the response of the CreateEntities endpoint
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityCreatedDto_2:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: "The unique ID of the Screening entity that has been created. \nCould be null if no entity has been created (for example, due to an error during the create operation)"
          format: uuid
          example: 8e167417-b8b2-4225-b9e9-b482f67644ba
        legalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDto'
          description: 'The search criteria of the entity that will be used to perform screening requests.

            If the entity has been created successfully, this data will be the same as in the request.

            However, if the entity already exists in the system, the data of the existing entity will be

            returned so users can review it'
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: 'The list of aliases for the entity that will be used to perform screening request

            If the entity has been created successfully, this data will be the same as in the request.

            However, if the entity already exists in the system, the data of the existing entity will be

            returned so users can review it'
        status:
          type:
          - string
          - 'null'
          description: The status of the operation
          example: Success
        errorMessage:
          type:
          - string
          - 'null'
          description: In case of an error, the details of the error that occurred during the execution of the operation
          example: The entity already exists
      additionalProperties: false
      description: Represents the data of an entity that has been created
    OngoingScreeningDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/OngoingScreeningDto'
          description: Represents the request to enable or disable ongoing screening for entities
      additionalProperties: false
    UpdateEntityDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateEntityDto'
          description: Represents the entity in the UpdateEntity request
      additionalProperties: false
    CreateEntityDtoListServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreateEntityDto'
      additionalProperties: false
    AddressDto:
      type: object
      properties:
        addressLine1:
          type:
          - string
          - 'null'
          description: The first line in the address
          example: 7107 Andell Rd
        addressLine2:
          type:
          - string
          - 'null'
          description: The second line in the address
          example: Portobello
        city:
          type:
          - string
          - 'null'
          description: The city
          example: Dublin
        postalCode:
          type:
          - string
          - 'null'
          description: The postal code
          example: D08 YY66
        country:
          type:
          - string
          - 'null'
          description: The country
          example: Ireland
        countryISO2:
          type:
          - string
          - 'null'
          description: The country ISO2 code
          example: IE
        countryISO3:
          type:
          - string
          - 'null'
          description: The country ISO3 code
          example: IRL
        stateProvince:
          type:
          - string
          - 'null'
          description: The state or province
          example: Dublin
        type:
          type:
          - string
          - 'null'
          description: The type
          example: Personal
      additionalProperties: false
      description: Represents the address dto
    OngoingScreeningDto:
      required:
      - entities
      type: object
      properties:
        enable:
          type: boolean
          description: Flag to determine if ongoing screening should be enabled or disabled
          example: true
        entities:
          type: array
          items:
            type: string
            format: uuid
          description: The list of entities for which ongoing screening should be enabled or disabled
        providers:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'The list of providers where ongoing screening should be enabled or disabled

            If this property is not provided then ongoing screening will be enabled or disabled for all the providers configured for ongoing screening for the tenant'
      additionalProperties: false
      description: Represents the request to enable or disable ongoing screening for entities
    UpdateEntityDto:
      required:
      - legalEntityId
      - searchCriteria
      type: object
      properties:
        legalEntityId:
          minLength: 1
          type: string
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDto'
          description: The search criteria of the entity that will be used to perform screening requests
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: The Alias information of the entity that is going to be screened. This can be empty if the entity has no aliases.
      additionalProperties: false
      description: Represents the entity in the UpdateEntity request
    EntitiesCreatedDto:
      type: object
      properties:
        totalNumberOfEntities:
          type: integer
          description: The total number of entities that were submitted
          format: int32
          example: 1
        numberOfEntitiesCreated:
          type: integer
          description: The number of entities that were created successfully
          format: int32
          example: 1
        numberOfEntitiesFailed:
          type: integer
          description: The number of entities that weren't created successfully
          format: int32
          example: 0
        entities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityCreatedDto_2'
          description: The details of the entities that were submitted
      additionalProperties: false
      description: Represents the response of the CreateEntities endpoint
    SearchCriteriaDto:
      required:
      - type
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's date of birth in DD/MM/YYYY format
          example: 31/12/1990
        gender:
          type:
          - string
          - 'null'
          description: The Individual's gender
          example: Male
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
        type:
          minLength: 1
          type: string
          description: Legal entity type i.e. Individual or Company
          example: Individual
        address:
          allOf:
          - $ref: '#/components/schemas/AddressDto'
          description: Address of the Individual, Company or Other
        idNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's ID number
          example: '1234'
        phoneNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's phone number
          example: 020 7946 0000
        emailAddress:
          type:
          - string
          - 'null'
          description: The Individual's or Company's email address
          example: john@doe.com
        nationality:
          type:
          - string
          - 'null'
          description: The Individual's nationality
          example: Irish
        countryOfResidence:
          type:
          - string
          - 'null'
          description: The Individual's country of residence
          example: Ireland
        placeOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's place of birth
          example: Dublin
        placeOfBirthISO2:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO2 code
          example: IE
        placeOfBirthISO3:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO3 code
          example: IRL
        citizenship:
          type:
          - string
          - 'null'
          description: The Individual's citizenship
          example: Ireland
        citizenshipISO2:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO2 code
          example: IE
        citizenshipISO3:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO3 code
          example: IRL
        registeredCountry:
          type:
          - string
          - 'null'
          description: The country the Company is registered in
          example: Ireland
        registeredCountryISO2:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO2 code
          example: IE
        registeredCountryISO3:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO3 code
          example: IRL
        subtype:
          type:
          - string
          - 'null'
          description: The subtype of an entity
          example: Vessel
        uniqueId:
          type:
          - string
          - 'null'
          description: The unique id of an entity that is part of a subtype
          example: VesselId
        otherInformation:
          type:
          - string
          - 'null'
          description: Other information about an individual or a company
          example: Information1|Information2|Information3
        passportNumber:
          type:
          - string
          - 'null'
          description: Passport number of the individual
          example: '123456789'
        socialSecurityNumber:
          type:
          - string
          - 'null'
          description: Social Security Number (SSN) of the individual
          example: 555-50-1234
        driversLicense:
          type:
          - string
          - 'null'
          description: Driver's License number of the individual
          example: SMITH580117SM9XJ
        employerIdentificationNumber:
          type:
          - string
          - 'null'
          description: Employer Identification Number (EIN) of the company
          example: 12-3456789
      additionalProperties: false
      description: The search criteria of the entity that will be used to perform screening requests
    EntityAliasDto:
      required:
      - id
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item.
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        aliasType:
          type:
          - string
          - 'null'
          description: The type of the alias
          example: Also Known As
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
      additionalProperties: false
      description: Class to represent a Screening entity Alias
    CreateEntityDto:
      required:
      - legalEntityId
      - searchCriteria
      type: object
      properties:
        legalEntityId:
          minLength: 1
          type: string
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDto'
          description: The search criteria of the entity that will be used to perform screening requests
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: The list of aliases for the entity that will be used to perform screening request
      additionalProperties: false
      description: Represents the entity in the CreateEntities request
    GetEntitiesSubscribedToOgsResponseDtoServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/GetEntitiesSubscribedToOgsResponseDto'
          description: Represents the response of the GetEntitiesSubscribedToOgs endpoint
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    GetEntitiesSubscribedToOgsResponseDto:
      type: object
      properties:
        signedUrl:
          type:
          - string
          - 'null'
          description: The signed url to get the results from
      additionalProperties: false
      description: Represents the response of the GetEntitiesSubscribedToOgs endpoint
    EntityCreatedDto_3:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: "The unique ID of the Screening entity that has been created. \nCould be null if no entity has been created (for example, due to an error during the create operation)"
          format: uuid
          example: 8e167417-b8b2-4225-b9e9-b482f67644ba
        legalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDto'
          description: 'The search criteria of the entity that will be used to perform screening requests.

            If the entity has been created successfully, this data will be the same as in the request.

            However, if the entity already exists in the system, the data of the existing entity will be

            returned so users can review it'
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: 'The list of aliases for the entity that will be used to perform screening request

            If the entity has been created successfully, this data will be the same as in the request.

            However, if the entity already exists in the system, the data of the existing entity will be

            returned so users can review it'
        status:
          type:
          - string
          - 'null'
          description: The status of the operation
          example: Success
        errorMessage:
          type:
          - string
          - 'null'
          description: In case of an error, the details of the error that occurred during the execution of the operation
          example: The entity already exists
      additionalProperties: false
      description: Represents the data of an entity that has been created
    EntitiesCreatedDto_2:
      type: object
      properties:
        totalNumberOfEntities:
          type: integer
          description: The total number of entities that were submitted
          format: int32
          example: 1
        numberOfEntitiesCreated:
          type: integer
          description: The number of entities that were created successfully
          format: int32
          example: 1
        numberOfEntitiesFailed:
          type: integer
          description: The number of entities that weren't created successfully
          format: int32
          example: 0
        entities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityCreatedDto_3'
          description: The details of the entities that were submitted
      additionalProperties: false
      description: Represents the response of the CreateEntities endpoint
    ToggleOngoingScreeningDto:
      required:
      - enable
      - entities
      type: object
      properties:
        enable:
          type: boolean
          description: Flag to determine whether to enable or disable ongoing screening for the provided entities
          example: true
        entities:
          type: array
          items:
            type: string
            format: uuid
          description: The list of entities to be subscribed or unsubscribed to ongoing screening
        providers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ToggleOngoingScreeningProviderDto'
          description: 'The list of providers to enable or disable ongoing screening for the provided entities.

            If this property is not set, the entities will be subscribed or unsubscribed from all the providers that have

            Ongoing Screening enabled in the tenant configuration.'
      additionalProperties: false
      description: Represents the request to enable or disable ongoing screening for entities
    EntitiesCreatedDtoV3:
      type: object
      properties:
        totalNumberOfEntities:
          type: integer
          description: The total number of entities that were submitted
          format: int32
          example: 1
        numberOfEntitiesCreated:
          type: integer
          description: The number of entities that were created successfully
          format: int32
          example: 1
        numberOfEntitiesFailed:
          type: integer
          description: The number of entities that weren't created successfully
          format: int32
          example: 0
        entities:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityCreatedDtoV3'
          description: The details of the entities that were submitted
      additionalProperties: false
    UpdateEntityDtoV3:
      required:
      - legalEntityId
      - searchCriteria
      type: object
      properties:
        legalEntityId:
          minLength: 1
          type: string
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDtoV3'
          description: The search criteria of the entity that will be used to perform screening requests
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: The Alias information of the entity that is going to be screened. This can be empty if the entity has no aliases.
      additionalProperties: false
      description: Represents the entity in the UpdateEntity request
    ToggleOngoingScreeningProviderDto:
      required:
      - providerId
      type: object
      properties:
        providerId:
          minLength: 1
          type: string
          description: The provider ID.
          example: ProviderId
        configurationSetId:
          type:
          - string
          - 'null'
          description: 'The configuration set ID where the entities will be subscribed or unsubscribed for ongoing screening in the provider.

            This field is mandatory for any provider set up to use the "Per Configuration Set" Ongoing Screening feature.

            The field can be left null if that feature is not used.'
          format: uuid
      additionalProperties: false
      description: Represents a provider for ongoing screening
    SearchCriteriaDtoV3:
      required:
      - type
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's date of birth in DD/MM/YYYY format
          example: 31/12/1990
        gender:
          type:
          - string
          - 'null'
          description: The Individual's gender
          example: Male
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
        type:
          minLength: 1
          type: string
          description: Legal entity type i.e. Individual or Company
          example: Individual
        addresses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AddressDto'
          description: List of address of the Individual, Company or Other
        idNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's ID number
          example: '1234'
        phoneNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's phone number
          example: 020 7946 0000
        emailAddress:
          type:
          - string
          - 'null'
          description: The Individual's or Company's email address
          example: john@doe.com
        nationality:
          type:
          - string
          - 'null'
          description: The Individual's nationality
          example: Irish
        countryOfResidence:
          type:
          - string
          - 'null'
          description: The Individual's country of residence
          example: Ireland
        placeOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's place of birth
          example: Dublin
        placeOfBirthISO2:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO2 code
          example: IE
        placeOfBirthISO3:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO3 code
          example: IRL
        citizenship:
          type:
          - string
          - 'null'
          description: The Individual's citizenship
          example: Ireland
        citizenshipISO2:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO2 code
          example: IE
        citizenshipISO3:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO3 code
          example: IRL
        registeredCountry:
          type:
          - string
          - 'null'
          description: The country the Company is registered in
          example: Ireland
        registeredCountryISO2:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO2 code
          example: IE
        registeredCountryISO3:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO3 code
          example: IRL
        subtype:
          type:
          - string
          - 'null'
          description: The subtype of an entity
          example: Vessel
        uniqueId:
          type:
          - string
          - 'null'
          description: The unique id of an entity that is part of a subtype
          example: VesselId
        otherInformation:
          type:
          - string
          - 'null'
          description: Other information about an individual or a company
          example: Information1|Information2|Information3
        passportNumber:
          type:
          - string
          - 'null'
          description: Passport number of the individual
          example: '123456789'
        socialSecurityNumber:
          type:
          - string
          - 'null'
          description: Social Security Number (SSN) of the individual
          example: 555-50-1234
        driversLicense:
          type:
          - string
          - 'null'
          description: Driver's License number of the individual
          example: SMITH580117SM9XJ
        employerIdentificationNumber:
          type:
          - string
          - 'null'
          description: Employer Identification Number (EIN) of the company
          example: 12-3456789
      additionalProperties: false
      description: The search criteria of the entity that will be used to perform screening requests
    UpdateEntityDtoV3ServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/UpdateEntityDtoV3'
          description: Represents the entity in the UpdateEntity request
      additionalProperties: false
    EntitiesCreatedDtoV3ServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/EntitiesCreatedDtoV3'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    CreateEntityDtoV3ListServiceRequest:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/CreateEntityDtoV3'
      additionalProperties: false
    ToggleOngoingScreeningDtoServiceRequest:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/ToggleOngoingScreeningDto'
          description: Represents the request to enable or disable ongoing screening for entities
      additionalProperties: false
    EntityCreatedDtoV3:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: "The unique ID of the Screening entity that has been created. \nCould be null if no entity has been created (for example, due to an error during the create operation)"
          format: uuid
          example: 8e167417-b8b2-4225-b9e9-b482f67644ba
        legalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDtoV3'
          description: 'The search criteria of the entity that will be used to perform screening requests.

            If the entity has been created successfully, this data will be the same as in the request.

            However, if the entity already exists in the system, the data of the existing entity will be

            returned so users can review it'
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: 'The list of aliases for the entity that will be used to perform screening request

            If the entity has been created successfully, this data will be the same as in the request.

            However, if the entity already exists in the system, the data of the existing entity will be

            returned so users can review it'
        status:
          type:
          - string
          - 'null'
          description: The status of the operation
          example: Success
        errorMessage:
          type:
          - string
          - 'null'
          description: In case of an error, the details of the error that occurred during the execution of the operation
          example: The entity already exists
      additionalProperties: false
      description: Represents the data of an entity that has been created
    CreateEntityDtoV3:
      required:
      - legalEntityId
      - searchCriteria
      type: object
      properties:
        legalEntityId:
          minLength: 1
          type: string
          description: The unique ID of a Legal Entity in Fen-X
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDtoV3'
          description: The search criteria of the entity that will be used to perform screening requests
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto'
          description: The list of aliases for the entity that will be used to perform screening request
      additionalProperties: false
      description: Represents the entity in the CreateEntities request
    BatchEntityDtoV2IEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BatchEntityDtoV2'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BatchEntityDtoV2ServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/BatchEntityDtoV2'
          description: Represents a Batch Entity V2
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    AddressDto_2:
      type: object
      properties:
        addressLine1:
          type:
          - string
          - 'null'
          description: The first line in the address
          example: 7107 Andell Rd
        addressLine2:
          type:
          - string
          - 'null'
          description: The second line in the address
          example: Portobello
        city:
          type:
          - string
          - 'null'
          description: The city
          example: Dublin
        postalCode:
          type:
          - string
          - 'null'
          description: The postal code
          example: D08 YY66
        country:
          type:
          - string
          - 'null'
          description: The country
          example: Ireland
        countryISO2:
          type:
          - string
          - 'null'
          description: The country ISO2 code
          example: IE
        countryISO3:
          type:
          - string
          - 'null'
          description: The country ISO3 code
          example: IRL
        stateProvince:
          type:
          - string
          - 'null'
          description: The state or province
          example: Leinster
        type:
          type:
          - string
          - 'null'
          description: The type
          example: Personal
        category:
          type:
          - string
          - 'null'
          description: The category of the address
          example: Residential
      additionalProperties: false
      description: Represents the address of an entity
    PropertyDto_4:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of property.
          readOnly: true
      additionalProperties: false
      description: Represents materiality assessment properties
    BatchEntityDtoV2:
      required:
      - searchCriteria
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the batch of entities to be screened. A batch can contain one or more entities.
          format: uuid
          example: 42fc9261-6343-4fb0-aea1-6023645ff84f
        legalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID for a Legal Entity in Fen-X
          example: 09470796-da15-4054-a61d-8667d2f03b8a
        entityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: CompanyName
        externalIds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExternalIdDto'
          description: ExternalIDs fetched from the providers
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDto_2'
          description: Search criteria specified in the request for the entity
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto_2'
          description: The list of aliases for the entity that will be used to perform screening request
        materialityAssessment:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              $ref: '#/components/schemas/PropertyDto_4'
          description: Materiality assessment dynamic properties
      additionalProperties: false
      description: Represents a Batch Entity V2
    ExternalIdDto:
      type: object
      properties:
        source:
          type:
          - string
          - 'null'
          description: The source of this externalId (LN, WCO, etc)
          example: MyProviderId
        entityAliasId:
          type:
          - string
          - 'null'
          description: What entity Alias this externalId is associated with. Will be null or "PrimaryName" for the PrimaryName external ids
          example: e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e
        name:
          type:
          - string
          - 'null'
          description: The name of the ID in the provider
          example: FieldInProvider
        value:
          type:
          - string
          - 'null'
          description: The value of the ID
          example: '1234'
      additionalProperties: false
      description: Dto to represent the external IDs fetched from the providers (runId, resultId, etc)
    SearchCriteriaDto_2:
      required:
      - type
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's date of birth in DD/MM/YYYY format
          example: 31/12/1990
        gender:
          type:
          - string
          - 'null'
          description: The Individual's gender
          example: Male
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
        type:
          minLength: 1
          type: string
          description: Legal entity type i.e. Individual or Company
          example: Individual
        address:
          allOf:
          - $ref: '#/components/schemas/AddressDto_2'
          description: Address of the Individual or Company
        idNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's ID number
          example: '1234'
        phoneNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's phone number
          example: 020 7946 0000
        emailAddress:
          type:
          - string
          - 'null'
          description: The Individual's or Company's email address
          example: john@doe.com
        nationality:
          type:
          - string
          - 'null'
          description: The Individual's nationality
          example: Irish
        countryOfResidence:
          type:
          - string
          - 'null'
          description: The Individual's country of residence
          example: Ireland
        placeOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's place of birth
          example: Dublin
        placeOfBirthISO2:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO2 code
          example: IE
        placeOfBirthISO3:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO3 code
          example: IRL
        citizenship:
          type:
          - string
          - 'null'
          description: The Individual's citizenship
          example: Irish
        citizenshipISO2:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO2 code
          example: IE
        citizenshipISO3:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO3 code
          example: IRL
        registeredCountry:
          type:
          - string
          - 'null'
          description: The country the Company is registered in
          example: Ireland
        registeredCountryISO2:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO2 code
          example: IE
        registeredCountryISO3:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO3 code
          example: IRL
        subtype:
          type:
          - string
          - 'null'
          description: The subtype of an entity
          example: Vessel
        uniqueId:
          type:
          - string
          - 'null'
          description: The unique id of an entity that is part of a subtype
          example: VesselId
        otherInformation:
          type:
          - string
          - 'null'
          description: Other information about an individual or a company
          example: Information1|Information2|Information3
        passportNumber:
          type:
          - string
          - 'null'
          description: Passport number of the individual
          example: '123456789'
        socialSecurityNumber:
          type:
          - string
          - 'null'
          description: Social Security Number (SSN) of the individual
          example: 555-50-1234
        driversLicense:
          type:
          - string
          - 'null'
          description: Driver's License number of the individual
          example: SMITH580117SM9XJ
        employerIdentificationNumber:
          type:
          - string
          - 'null'
          description: Employer Identification Number (EIN) of the company
          example: 12-3456789
      additionalProperties: false
      description: Represent the Search Criteria to perform a Screen request
    EntityAliasDto_2:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item.
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        aliasType:
          type:
          - string
          - 'null'
          description: The type of the alias
          example: Also Known As
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
      additionalProperties: false
      description: Class to represent a Screening entity Alias
    AddressDto_3:
      type: object
      properties:
        addressLine1:
          type:
          - string
          - 'null'
          description: The first line in the address
          example: 7107 Andell Rd
        addressLine2:
          type:
          - string
          - 'null'
          description: The second line in the address
          example: Portobello
        city:
          type:
          - string
          - 'null'
          description: The city
          example: Dublin
        postalCode:
          type:
          - string
          - 'null'
          description: The postal code
          example: D08 YY66
        country:
          type:
          - string
          - 'null'
          description: The country
          example: Ireland
        countryISO2:
          type:
          - string
          - 'null'
          description: The country ISO2 code
          example: IE
        countryISO3:
          type:
          - string
          - 'null'
          description: The country ISO3 code
          example: IRL
        stateProvince:
          type:
          - string
          - 'null'
          description: The state or province
          example: Leinster
        type:
          type:
          - string
          - 'null'
          description: The type
          example: Personal
        category:
          type:
          - string
          - 'null'
          description: The category of the address
          example: Residential
      additionalProperties: false
      description: Represents the address of an entity
    PropertyDto_5:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of property.
          readOnly: true
      additionalProperties: false
      description: Represents materiality assessment properties
    BatchEntityDtoV2_2:
      required:
      - searchCriteria
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the batch of entities to be screened. A batch can contain one or more entities.
          format: uuid
          example: 42fc9261-6343-4fb0-aea1-6023645ff84f
        legalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID for a Legal Entity in Fen-X
          example: 09470796-da15-4054-a61d-8667d2f03b8a
        entityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: CompanyName
        externalIds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExternalIdDto'
          description: ExternalIDs fetched from the providers
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDto_3'
          description: Search criteria specified in the request for the entity
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto_3'
          description: The list of aliases for the entity that will be used to perform screening request
        materialityAssessment:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              $ref: '#/components/schemas/PropertyDto_5'
          description: Materiality assessment dynamic properties
      additionalProperties: false
      description: Represents a Batch Entity V2
    SearchCriteriaDto_3:
      required:
      - type
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's date of birth in DD/MM/YYYY format
          example: 31/12/1990
        gender:
          type:
          - string
          - 'null'
          description: The Individual's gender
          example: Male
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
        type:
          minLength: 1
          type: string
          description: Legal entity type i.e. Individual or Company
          example: Individual
        address:
          allOf:
          - $ref: '#/components/schemas/AddressDto_3'
          description: Address of the Individual or Company
        idNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's ID number
          example: '1234'
        phoneNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's phone number
          example: 020 7946 0000
        emailAddress:
          type:
          - string
          - 'null'
          description: The Individual's or Company's email address
          example: john@doe.com
        nationality:
          type:
          - string
          - 'null'
          description: The Individual's nationality
          example: Irish
        countryOfResidence:
          type:
          - string
          - 'null'
          description: The Individual's country of residence
          example: Ireland
        placeOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's place of birth
          example: Dublin
        placeOfBirthISO2:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO2 code
          example: IE
        placeOfBirthISO3:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO3 code
          example: IRL
        citizenship:
          type:
          - string
          - 'null'
          description: The Individual's citizenship
          example: Irish
        citizenshipISO2:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO2 code
          example: IE
        citizenshipISO3:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO3 code
          example: IRL
        registeredCountry:
          type:
          - string
          - 'null'
          description: The country the Company is registered in
          example: Ireland
        registeredCountryISO2:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO2 code
          example: IE
        registeredCountryISO3:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO3 code
          example: IRL
        subtype:
          type:
          - string
          - 'null'
          description: The subtype of an entity
          example: Vessel
        uniqueId:
          type:
          - string
          - 'null'
          description: The unique id of an entity that is part of a subtype
          example: VesselId
        otherInformation:
          type:
          - string
          - 'null'
          description: Other information about an individual or a company
          example: Information1|Information2|Information3
        passportNumber:
          type:
          - string
          - 'null'
          description: Passport number of the individual
          example: '123456789'
        socialSecurityNumber:
          type:
          - string
          - 'null'
          description: Social Security Number (SSN) of the individual
          example: 555-50-1234
        driversLicense:
          type:
          - string
          - 'null'
          description: Driver's License number of the individual
          example: SMITH580117SM9XJ
        employerIdentificationNumber:
          type:
          - string
          - 'null'
          description: Employer Identification Number (EIN) of the company
          example: 12-3456789
      additionalProperties: false
      description: Represent the Search Criteria to perform a Screen request
    EntityAliasDto_3:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item.
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        aliasType:
          type:
          - string
          - 'null'
          description: The type of the alias
          example: Also Known As
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
      additionalProperties: false
      description: Class to represent a Screening entity Alias
    BatchEntityDtoV3ServiceResponse:
      type: object
      properties:
        data:
          allOf:
          - $ref: '#/components/schemas/BatchEntityDtoV3'
          description: Represents a Batch Entity V3
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    EntityMaterialityAssessmentResultDto:
      type: object
      properties:
        materialityStatus:
          type:
          - string
          - 'null'
          description: Indicates the overall result of the assessment
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'The jurisdictions that are relevant to the materiality assessment, which may have influenced the decision.

            It will only be populated when the MaterialityStatus is "Material" to provide context on which jurisdictions

            contributed to the materiality decision'
      additionalProperties: false
      description: Represents the result of a materiality assessment.
    PropertyDto_6:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/PropertyType'
          description: Type of property.
          readOnly: true
      additionalProperties: false
      description: Represents materiality assessment properties
    EntityAliasDto_4:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item.
          example: 12be5a50-66c2-44bb-851e-afc4fc4a28c2
        aliasType:
          type:
          - string
          - 'null'
          description: The type of the alias
          example: Also Known As
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
      additionalProperties: false
      description: Class to represent a Screening entity Alias
    EntityMaterialityAssessmentDto:
      type: object
      properties:
        pep:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto'
          description: The materiality assessment result for Pep
        sanctions:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentSanctionsResultDto'
          description: The materiality assessment result for Sanctions
        adverseMedia:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto'
          description: The materiality assessment result for AdverseMedia
        enforcements:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto'
          description: The materiality assessment result for Enforcements
        other:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto'
          description: The materiality assessment result for Other
        lastActionedBy:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentLastActionedByDto'
          description: Details of the last action taken on the materiality assessment.
        rationale:
          type:
          - string
          - 'null'
          description: The rationale behind the materiality assessment decision, providing context and justification for the results.
        materialityOutcome:
          type:
          - string
          - 'null'
          description: The overall materiality outcome based on the assessment results (Material, Immaterial, None).
      additionalProperties: false
      description: 'Represents the materiality assessment details for a batch entity, including materiality assessment results

        for PEP, sanctions, adverse media, enforcements, and other relevant factors.'
    AddressDto_4:
      type: object
      properties:
        addressLine1:
          type:
          - string
          - 'null'
          description: The first line in the address
          example: 7107 Andell Rd
        addressLine2:
          type:
          - string
          - 'null'
          description: The second line in the address
          example: Portobello
        city:
          type:
          - string
          - 'null'
          description: The city
          example: Dublin
        postalCode:
          type:
          - string
          - 'null'
          description: The postal code
          example: D08 YY66
        country:
          type:
          - string
          - 'null'
          description: The country
          example: Ireland
        countryISO2:
          type:
          - string
          - 'null'
          description: The country ISO2 code
          example: IE
        countryISO3:
          type:
          - string
          - 'null'
          description: The country ISO3 code
          example: IRL
        stateProvince:
          type:
          - string
          - 'null'
          description: The state or province
          example: Leinster
        type:
          type:
          - string
          - 'null'
          description: The type
          example: Personal
        category:
          type:
          - string
          - 'null'
          description: The category of the address
          example: Residential
      additionalProperties: false
      description: Represents the address of an entity
    BatchEntityDtoV3IEnumerableServiceResponse:
      type: object
      properties:
        data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BatchEntityDtoV3'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ServiceResponseMessage'
      additionalProperties: false
    BatchEntityDtoV3:
      required:
      - searchCriteria
      type: object
      properties:
        id:
          type: string
          description: The unique ID for the batch of entities to be screened. A batch can contain one or more entities.
          format: uuid
          example: 42fc9261-6343-4fb0-aea1-6023645ff84f
        legalEntityId:
          type:
          - string
          - 'null'
          description: The unique ID for a Legal Entity in Fen-X
          example: 09470796-da15-4054-a61d-8667d2f03b8a
        entityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: CompanyName
        externalIds:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExternalIdDto'
          description: ExternalIDs fetched from the providers
        searchCriteria:
          allOf:
          - $ref: '#/components/schemas/SearchCriteriaDtoV2'
          description: Search criteria specified in the request for the entity
        entityAliases:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EntityAliasDto_4'
          description: The list of aliases for the entity that will be used to perform screening request
        materialityAssessment:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - object
            - 'null'
            additionalProperties:
              $ref: '#/components/schemas/PropertyDto_6'
          description: Materiality assessment dynamic properties (for related parties)
        entityMaterialityAssessment:
          allOf:
          - $ref: '#/components/schemas/EntityMaterialityAssessmentDto'
          description: 'The materiality assessment details for a batch entity, including materiality assessment results

            for PEP, sanctions, adverse media, enforcements, and other relevant factors.'
        materialityTaskEscalatedDetails:
          allOf:
          - $ref: '#/components/schemas/MaterialityTaskEscalatedDetailsDto'
          description: The escalation details for a materiality assessment task, populated when the task has been escalated.
        impactedClients:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImpactedClientDto'
          description: 'The list of clients impacted by a confirmed OGS hit, with the compliance officer''s

            decision on whether a follow-up ODS journey should be triggered for each client.

            Only populated for Ongoing Screening batches.'
      additionalProperties: false
      description: Represents a Batch Entity V3
    ImpactedClientDto:
      type: object
      properties:
        legalEntityId:
          type:
          - string
          - 'null'
          description: The legal entity ID of the impacted client
        isSelected:
          type: boolean
          description: Whether this client requires a follow-up ODS journey
        reasonForNoFollowUp:
          type:
          - string
          - 'null'
          description: Justification when the client is deselected
      additionalProperties: false
      description: 'Represents a client impacted by a confirmed OGS hit, with the compliance officer''s

        decision on whether a follow-up ODS journey should be triggered.'
    SearchCriteriaDtoV2:
      required:
      - type
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
          description: The Individual's firstname and surname. Alternatively use FirstName with LastName.
          example: John Doe
        firstName:
          type:
          - string
          - 'null'
          description: The Individual's first name. Alternatively use FullName.
          example: John
        middleName:
          type:
          - string
          - 'null'
          description: The Individual's middle name
          example: David
        lastName:
          type:
          - string
          - 'null'
          description: The Individual's surname. Alternatively use FullName.
          example: Doe
        dateOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's date of birth in DD/MM/YYYY format
          example: 31/12/1990
        gender:
          type:
          - string
          - 'null'
          description: The Individual's gender
          example: Male
        legalEntityName:
          type:
          - string
          - 'null'
          description: Full Company name
          example: Fenergo
        type:
          minLength: 1
          type: string
          description: Legal entity type i.e. Individual or Company
          example: Individual
        addresses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AddressDto_4'
          description: List of address of the Individual, Company or Other
        idNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's ID number
          example: '1234'
        phoneNumber:
          type:
          - string
          - 'null'
          description: The Individual's or Company's phone number
          example: 020 7946 0000
        emailAddress:
          type:
          - string
          - 'null'
          description: The Individual's or Company's email address
          example: john@doe.com
        nationality:
          type:
          - string
          - 'null'
          description: The Individual's nationality
          example: Irish
        countryOfResidence:
          type:
          - string
          - 'null'
          description: The Individual's country of residence
          example: Ireland
        placeOfBirth:
          type:
          - string
          - 'null'
          description: The Individual's place of birth
          example: Dublin
        placeOfBirthISO2:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO2 code
          example: IE
        placeOfBirthISO3:
          type:
          - string
          - 'null'
          description: The Individual's place of birth in country ISO3 code
          example: IRL
        citizenship:
          type:
          - string
          - 'null'
          description: The Individual's citizenship
          example: Irish
        citizenshipISO2:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO2 code
          example: IE
        citizenshipISO3:
          type:
          - string
          - 'null'
          description: The Individual's citizenship in country ISO3 code
          example: IRL
        registeredCountry:
          type:
          - string
          - 'null'
          description: The country the Company is registered in
          example: Ireland
        registeredCountryISO2:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO2 code
          example: IE
        registeredCountryISO3:
          type:
          - string
          - 'null'
          description: The country the Company is registered in ISO3 code
          example: IRL
        subtype:
          type:
          - string
          - 'null'
          description: The subtype of an entity
          example: Vessel
        uniqueId:
          type:
          - string
          - 'null'
          description: The unique id of an entity that is part of a subtype
          example: VesselId
        otherInformation:
          type:
          - string
          - 'null'
          description: Other information about an individual or a company
          example: Information1|Information2|Information3
        passportNumber:
          type:
          - string
          - 'null'
          description: Passport number of the individual
          example: '123456789'
        socialSecurityNumber:
          type:
          - string
          - 'null'
          description: Social Security Number (SSN) of the individual
          example: 555-50-1234
        driversLicense:
          type:
          - string
          - 'null'
          description: Driver's License number of the individual
          example: SMITH580117SM9XJ
        employerIdentificationNumber:
          type:
          - string
          - 'null'
          description: Employer Identification Number (EIN) of the company
          example: 12-3456789
      additionalProperties: false
      description: Represent the Search Criteria to perform a Screen request
    MaterialityTaskEscalatedDetailsDto:
      type: object
      properties:
        teamId:
          type: string
          description: The ID of the team the task was escalated to.
          format: uuid
        userId:
          type:
          - string
          - 'null'
          description: The ID of the user the task was escalated to.
        comment:
          type:
          - string
          - 'null'
          description: The reason or comment provided for the escalation.
        escalatedBy:
          type:
          - string
          - 'null'
          description: The ID of the user who performed the escalation.
        escalatedAt:
          type: string
          description: The UTC timestamp when the escalation occurred.
          format: date-time
      additionalProperties: false
      description: Represents the escalation details for a materiality assessment task.
    EntityMaterialityAssessmentSanctionsResultDto:
      type: object
      properties:
        materialityStatus:
          type:
          - string
          - 'null'
          description: Indicates the overall result of the assessment
        jurisdictions:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'The jurisdictions that are relevant to the materiality assessment, which may have influenced the decision.

            It will only be populated when the MaterialityStatus is "Material" to provide context on which jurisdictions

            contributed to the materiality decision'
        okToProceed:
          type:
          - boolean
          - 'null'
          description: 'Indicates whether it is acceptable to proceed with the entity based on the sanctions materiality assessment.

            It will only be populated when the MaterialityStatus is "Material" to provide guidance on whether the entity can

            proceed despite being deemed material due to sanctions concerns.'
        rationale:
          type:
          - string
          - 'null'
          description: 'The rationale behind the materiality assessment decision, providing context and justification for the results.

            It will only be populated when the MaterialityStatus is "Material" to explain the reasoning behind the materiality decision'
      additionalProperties: false
      description: Represents the result of a Sanctions materiality assessment.
    EntityMaterialityAssessmentLastActionedByDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          description: The ID of the user or client that performed the materiality assessment action
        type:
          type:
          - string
          - 'null'
          description: The type of actor that performed the action (User, Client)
        actionedOn:
          type:
          - string
          - 'null'
          description: The date and time when the action was performed
          format: date-time
        journeyTaskId:
          type:
          - string
          - 'null'
          description: The ID of the journey task associated with the action
      additionalProperties: false
      description: 'DTO representing the last action taken on an entity materiality assessment.

        Includes the user or client that performed the action and the timestamp of when it occurred.'
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-associationcommand-v1-0-openapi.json
- fenergo-associationcommand-v2-0-openapi.json
- fenergo-associationquery-v1-0-openapi.json
- fenergo-auditquery-v3-0-openapi.json
- fenergo-entitydatacommand-v1-0-openapi.json
- fenergo-entitydatacommand-v2-0-openapi.json
- fenergo-entitydataquery-v1-0-openapi.json
- fenergo-entitydataquery-v2-0-openapi.json
- fenergo-screeningcommand-v1-0-openapi.json
- fenergo-screeningcommand-v2-0-openapi.json
- fenergo-screeningcommand-v3-0-openapi.json
- fenergo-screeningquery-v2-0-openapi.json
- fenergo-screeningquery-v3-0-openapi.json
- fenergo-screeningquery-v4-0-openapi.json