openapi: 3.2.0 info: title: Fenergo Batch API version: '1.0' description: 'Operations tagged Batch across 7 of this provider''s published API definitions: fenergo-screeningcommand-v1-0-openapi.json, fenergo-screeningcommand-v2-0-openapi.json, fenergo-screeningcommand-v3-0-openapi.json, fenergo-screeningquery-v1-0-openapi.json, fenergo-screeningquery-v2-0-openapi.json, fenergo-screeningquery-v3-0-openapi.json, fenergo-screeningquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /screeningcommand - url: /screeningquery security: - Bearer: [] tags: - name: Batch paths: /api/batch: post: tags: - Batch summary: Create a new screening batch to screen one or more entities description: 'This method creates a screening batch that triggers asynchronous requests to different screening providers. This batch ID can be used in the Screening Query Api to check the status of the request and to get the screening results. The method returns the batch ID created in the system. For Individuals, the mandatory fields are; tenant + fullName + type OR tenant + firstName + lastName + type. For Company’s, the mandatory fields are tenant + type + LEName. If providers is null the batch will be created with the active providers. If configuration set is null the batch will be created for the specified provider with the default configuration set. Otherwise the batch will be created with the providers and configuration sets specified in the request. Required permissions: Following permissions are required: ScreeningCreate, ScreeningAccess' operationId: CreateBatch 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 Create Batch request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateBatchDtoServiceRequest' responses: '202': description: Success. Batch created content: application/json: schema: $ref: '#/components/schemas/BatchCreatedDtoServiceResponse' '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/batch/{id}/complete: put: tags: - Batch summary: Complete an existing screening batch description: 'This method is used to complete an existing batch All providers must have status ''Search Complete'' or ''Return Failed'' All matches must be resolved Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: CompleteBatch parameters: - name: id in: path description: The ID of the existing batch to be completed required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted. The request to complete the batch has been accepted '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 batch couldn't 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: /screeningcommand /api/batch/{id}/matches: put: tags: - Batch summary: Update a list of matches in a batch description: 'This method is used to update the status, reason and comments of a list of matches. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: UpdateMatches parameters: - name: id in: path description: The ID of the batch 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 list of matches to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityMatchesDtoListServiceRequest' responses: '202': description: Accepted. The request to update the list of matches 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/batch/{id}/entity/{entityId}/updatemateriality: put: tags: - Batch summary: Update the materiality assessment of an Entity's related party in ongoing… description: 'This method is used to update the materiality assessment of an Entity''s related party. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: UpdateMaterialityAssessment parameters: - name: id in: path description: The ID of the ongoing screening batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch 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 related party to be updated and the set of values for the materiality assessment content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateMaterialityAssessmentDtoServiceRequest' responses: '202': description: Accepted. The request to update the materiality assessment 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/v2/batch: post: tags: - Batch summary: Create a new screening batch to screen one or more entities description: 'This method creates a screening batch that triggers asynchronous requests to different screening providers. This batch ID can be used in the Screening Query Api to check the status of the request and to get the screening results. The method returns the batch ID created in the system. For Individuals, the mandatory fields are; tenant + fullName + type OR tenant + firstName + lastName + type. For Company’s, the mandatory fields are tenant + type + LEName. If providers is null the batch will be created with the active providers. If configuration set is null the batch will be created for the specified provider with the default configuration set. Otherwise the batch will be created with the providers and configuration sets specified in the request. Required permissions: Following permissions are required: ScreeningCreate, ScreeningAccess' operationId: postApiV2Batch 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 Create Batch request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateBatchDtoServiceRequest' responses: '202': description: Success. Batch created content: application/json: schema: $ref: '#/components/schemas/BatchCreatedDtoServiceResponse' '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: CreateBatch servers: - url: /screeningcommand /api/v2/batch/{id}/complete: put: tags: - Batch summary: Complete an existing screening batch description: 'This method is used to complete an existing batch All providers must have status ''Search Complete'' or ''Return Failed'' All matches must be resolved Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: putApiV2BatchByIdComplete parameters: - name: id in: path description: The ID of the existing batch to be completed required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted. The request to complete the batch has been accepted '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 batch couldn't 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: CompleteBatch servers: - url: /screeningcommand /api/v2/batch/{id}/matches: put: tags: - Batch summary: Update a list of matches in a batch description: 'This method is used to update the status, reason and comments of a list of matches. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: putApiV2BatchByIdMatches parameters: - name: id in: path description: The ID of the batch 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 list of matches to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityMatchesDtoListServiceRequest' responses: '202': description: Accepted. The request to update the list of matches 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: UpdateMatches servers: - url: /screeningcommand /api/v2/batch/{id}/entity/{entityId}/updatemateriality: put: tags: - Batch summary: Update the materiality assessment of an Entity's related party in ongoing… description: 'This method is used to update the materiality assessment of an Entity''s related party. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: putApiV2BatchByIdEntityByEntityIdUpdatemateriality parameters: - name: id in: path description: The ID of the ongoing screening batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch 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 related party to be updated and the set of values for the materiality assessment content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateMaterialityAssessmentDtoServiceRequest' responses: '202': description: Accepted. The request to update the materiality assessment 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: UpdateMaterialityAssessment servers: - url: /screeningcommand /api/v3/batch: post: tags: - Batch summary: Create a new screening batch to screen one or more entities description: 'This method creates a screening batch that triggers asynchronous requests to different screening providers. This batch ID can be used in the Screening Query Api to check the status of the request and to get the screening results. The method returns the batch ID created in the system. For Individuals, the mandatory fields are; tenant + fullName + type OR tenant + firstName + lastName + type. For Company’s, the mandatory fields are tenant + type + LEName. If providers is null the batch will be created with the active providers. If configuration set is null the batch will be created for the specified provider with the default configuration set. Otherwise the batch will be created with the providers and configuration sets specified in the request. Required permissions: Following permissions are required: ScreeningCreate, ScreeningAccess' operationId: CreateBatchV3 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 Create Batch request content: application/json: schema: allOf: - $ref: '#/components/schemas/CreateBatchDtoV3ServiceRequest' responses: '202': description: Success. Batch created content: application/json: schema: $ref: '#/components/schemas/BatchCreatedDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '500': description: Internal server error '403': description: Forbidden. The feature is disabled or the user lacks the necessary permissions '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/batch/{id}/complete: put: tags: - Batch summary: Complete an existing screening batch description: 'This method is used to complete an existing batch All providers must have status ''Search Complete'' or ''Return Failed'' All matches must be resolved Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: CompleteBatchV3 parameters: - name: id in: path description: The ID of the existing batch to be completed required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted. The request to complete the batch has been accepted '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 batch couldn't be found type: Error errorCode: Error Code '500': description: Internal server error '403': description: Forbidden. The feature is disabled or the user lacks the necessary permissions '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/batch/{id}/matches: put: tags: - Batch summary: Update a list of matches in a batch description: 'This method is used to update the status, reason and comments of a list of matches. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: UpdateMatchesV3 parameters: - name: id in: path description: The ID of the batch 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 list of matches to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateEntityMatchesDtoListServiceRequest' responses: '202': description: Accepted. The request to update the list of matches 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 '403': description: Forbidden. The feature is disabled or the user lacks the necessary permissions '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/batch/{id}/entity/{entityId}/updatemateriality: put: tags: - Batch summary: Update the materiality assessment of an Entity's related party in ongoing… description: 'This method is used to update the materiality assessment of an Entity''s related party. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: UpdateMaterialityAssessmentV3 parameters: - name: id in: path description: The ID of the ongoing screening batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch 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 related party to be updated and the set of values for the materiality assessment content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateMaterialityAssessmentDtoServiceRequest' responses: '202': description: Accepted. The request to update the materiality assessment 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 '403': description: Forbidden. The feature is disabled or the user lacks the necessary permissions '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/batch/{id}/entity/{entityId}: put: tags: - Batch summary: Updates an existing Screening Batch Entity with the data supplied in the… description: 'This method is used to update the data of an existing Screening Batch Entity. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: UpdateBatchEntityV3 parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch 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 to be updated content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateBatchEntityDtoServiceRequest' responses: '202': description: Accepted. The request to update the batch entity 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' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The batch or entity couldn't be found type: Error errorCode: Error Code '415': description: Unsupported media type. The request has an unsupported media type content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '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/batch/{id}/entity/{entityId}/escalatematerialitytask: put: tags: - Batch summary: Escalates a materiality assessment task to second-line review description: 'Allows a first-line user to escalate a screening and materiality assessment task when it cannot be completed. The escalation notifies a target team and/or user and includes a comment. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: EscalateMaterialityAssessmentTask parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch 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 escalation details including team, user, and comment content: application/json: schema: allOf: - $ref: '#/components/schemas/EscalateMaterialityAssessmentTaskDtoServiceRequest' responses: '202': description: Accepted. The request to escalate the entity 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' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The batch or entity couldn't be found type: Error errorCode: Error Code '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/batch/{id}/entity/{entityId}/deescalatematerialitytask: put: tags: - Batch summary: De-escalates a materiality assessment task description: 'De-escalates a materiality assessment task for the given entity. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: DeEscalateMaterialityAssessmentTask parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted. The request to de-escalate the entity 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' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The batch or entity couldn't be found type: Error errorCode: Error Code '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/batch/{id}/entity/{entityId}/documents/upload-url: post: tags: - Batch summary: Initiates an entity document upload by returning a pre-signed URL description: 'Registers a document reference on the entity and returns a pre-signed URL for the client to upload the file directly to storage. An optional idempotency key can be supplied to prevent duplicate document registrations. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: GenerateEntityDocumentUploadUrl parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch 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: Document metadata including file name, type, and optional idempotency key content: application/json: schema: allOf: - $ref: '#/components/schemas/UploadEntityDocumentDtoServiceRequest' responses: '202': description: Accepted. Returns the document ID and pre-signed upload URL content: application/json: schema: $ref: '#/components/schemas/UploadEntityDocumentResponseDtoServiceResponse' '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 batch or entity could not be found type: Error errorCode: Error Code '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/batch/{id}/entity/{entityId}/documents/reuse: post: tags: - Batch summary: Reuses an existing document uploaded previously to the entity specified in the… description: 'Creates a new document reference on the target entity pointing to the same physical file as a document in a previous batch. The source document must have a Completed status. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: ReuseEntityDocument parameters: - name: id in: path description: The ID of the target batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the target batch 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 document ID and source batch to reuse from content: application/json: schema: allOf: - $ref: '#/components/schemas/ReuseEntityDocumentDtoServiceRequest' responses: '202': description: Accepted. Returns the new document ID in the target batch content: application/json: schema: $ref: '#/components/schemas/ReuseEntityDocumentResponseDtoServiceResponse' '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 batch, entity, or source document could not be found type: Error errorCode: Error Code '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/batch/{id}/entity/{entityId}/documents/{documentId}: delete: tags: - Batch summary: Deletes an entity document reference from a batch entity description: 'Removes the document reference from the entity. If this is the last reference to the physical file, the file will be deleted from Document Management as well. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: DeleteEntityDocument parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch required: true schema: type: string format: uuid - name: documentId in: path description: The ID of the document to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: 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' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The batch, entity, or document could not be found type: Error errorCode: Error Code '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '204': description: No content. The document has been successfully removed '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/batch/{id}/entity/{entityId}/match/{matchId}/documents/upload-url: post: tags: - Batch summary: Generates a pre-signed URL for uploading a document to a match hit description: 'Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: GenerateMatchDocumentUploadUrl parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match on 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: The document upload details content: application/json: schema: allOf: - $ref: '#/components/schemas/UploadMatchDocumentDtoServiceRequest' responses: '202': description: Accepted. Returns the new document ID and the pre-signed upload URL content: application/json: schema: $ref: '#/components/schemas/UploadMatchDocumentResponseDtoServiceResponse' '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 batch, entity, or match could not be found type: Error errorCode: Error Code '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/batch/{id}/entity/{entityId}/match/{matchId}/documents/reuse: post: tags: - Batch summary: Reuses an existing document uploaded previously to the match specified in the… description: 'Creates a new document reference on the target match pointing to the same physical file as a document in a previous batch. The source document must have a Completed status and the source match must share the same MatchEntityUniqueId as the target match. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: ReuseMatchDocument parameters: - name: id in: path description: The ID of the target batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the target batch required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match in the target batch 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 document ID, source batch ID, and source match ID to reuse from content: application/json: schema: allOf: - $ref: '#/components/schemas/ReuseMatchDocumentDtoServiceRequest' responses: '202': description: Accepted. Returns the new document ID in the target batch content: application/json: schema: $ref: '#/components/schemas/ReuseMatchDocumentResponseDtoServiceResponse' '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 batch, entity, match, or source document could not be found type: Error errorCode: Error Code '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/batch/{id}/entity/{entityId}/match/{matchId}/documents/{documentId}: delete: tags: - Batch summary: Deletes a match document reference from a batch match description: 'Removes the document reference from the match. If this is the last reference to the physical file, the file will be deleted from Document Management as well. Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: DeleteMatchDocument parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: entityId in: path description: The ID of the entity in the batch required: true schema: type: string format: uuid - name: matchId in: path description: The ID of the match in the batch required: true schema: type: string format: uuid - name: documentId in: path description: The ID of the document to delete required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted. The document has been successfully removed 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' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not found. The batch, entity, match, or document could not be found type: Error errorCode: Error Code '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/batch/{id}/aggregate-entity-materiality: post: tags: - Batch summary: Calculates final materiality across all entities in the batch and writes the… description: 'Required permissions: Following permissions are required: ScreeningEdit, ScreeningAccess' operationId: AggregateEntityMateriality parameters: - name: id in: path description: The ID of the batch required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted. Final materiality calculated and written to entity draft content: application/json: schema: $ref: '#/components/schemas/FinalMaterialityResultDtoServiceResponse' '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 batch could not be found type: Error errorCode: Error Code '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/batch/{id}: get: tags: - Batch summary: Get data of an existing batch with batch Id description: 'This method gets all the batch data for a given batch Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchById parameters: - name: id in: path description: The Id of the existing batch to get 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 batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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/batch/journey/{journeyId}: get: tags: - Batch summary: Get data of an existing batch with journey Id description: 'This method gets all the batch data linked to a journey Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchByJourneyId parameters: - name: journeyId in: path description: The Id of the journey 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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/batch/journey/{journeyId}/process/{processId}: get: tags: - Batch summary: Get data of an existing batch with journey Id and process Id description: 'This method gets all the batch data linked to a journey Id, process Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchByJourneyAndProcessId parameters: - name: journeyId in: path description: The Id of the journey required: true schema: type: string - name: processId in: path description: The Id of the process that started the batch 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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/batch/legalentity/{legalEntityId}: get: tags: - Batch summary: Get the batches with Legal Entity Id description: 'This method gets all the batches linked to a Legal Entity Id and Tenant Id. The method returns the batch array. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchesByLegalEntityId parameters: - name: legalEntityId in: path description: The Id of the Legal Entity required: true schema: type: string - name: onlyWithTrueMatches in: query description: Flag to return only the batches with true matches 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 batches are returned content: application/json: schema: $ref: '#/components/schemas/LegalEntityBatchDtoIEnumerableServiceResponse' '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 Legal Entity couldn't 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/v2/batch/{id}: get: tags: - Batch summary: Get data of an existing batch with batch Id description: 'This method gets all the batch data for a given batch Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2BatchById parameters: - name: id in: path description: The Id of the existing batch to get 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 batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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: GetBatchById servers: - url: /screeningquery /api/v2/batch/journey/{journeyId}: get: tags: - Batch summary: Get data of an existing batch with journey Id description: 'This method gets all the batch data linked to a journey Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2BatchJourneyByJourneyId parameters: - name: journeyId in: path description: The Id of the journey 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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: GetBatchByJourneyId servers: - url: /screeningquery /api/v2/batch/journey/{journeyId}/process/{processId}: get: tags: - Batch summary: Get data of an existing batch with journey Id and process Id description: 'This method gets all the batch data linked to a journey Id, process Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2BatchJourneyByJourneyIdProcessByProcessId parameters: - name: journeyId in: path description: The Id of the journey required: true schema: type: string - name: processId in: path description: The Id of the process that started the batch 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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: GetBatchByJourneyAndProcessId servers: - url: /screeningquery /api/v2/batch/legalentity/{legalEntityId}: get: tags: - Batch summary: Get the batches with Legal Entity Id description: 'This method gets all the batches linked to a Legal Entity Id and Tenant Id. The method returns the batch array. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV2BatchLegalentityByLegalEntityId parameters: - name: legalEntityId in: path description: The Id of the Legal Entity required: true schema: type: string - name: onlyWithTrueMatches in: query description: Flag to return only the batches with true matches 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 batches are returned content: application/json: schema: $ref: '#/components/schemas/LegalEntityBatchDtoIEnumerableServiceResponse' '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 Legal Entity couldn't 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: GetBatchesByLegalEntityId servers: - url: /screeningquery /api/v3/batch/{id}: get: tags: - Batch summary: Get data of an existing batch with batch Id description: 'This method gets all the batch data for a given batch Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3BatchById parameters: - name: id in: path description: The Id of the existing batch to get 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 batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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: GetBatchById servers: - url: /screeningquery /api/v3/batch/journey/{journeyId}: get: tags: - Batch summary: Get data of an existing batch with journey Id description: 'This method gets all the batch data linked to a journey Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3BatchJourneyByJourneyId parameters: - name: journeyId in: path description: The Id of the journey 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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: GetBatchByJourneyId servers: - url: /screeningquery /api/v3/batch/journey/{journeyId}/process/{processId}: get: tags: - Batch summary: Get data of an existing batch with journey Id and process Id description: 'This method gets all the batch data linked to a journey Id, process Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3BatchJourneyByJourneyIdProcessByProcessId parameters: - name: journeyId in: path description: The Id of the journey required: true schema: type: string - name: processId in: path description: The Id of the process that started the batch 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoServiceResponse' '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 batch couldn't 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: GetBatchByJourneyAndProcessId servers: - url: /screeningquery /api/v3/batch/legalentity/{legalEntityId}: get: tags: - Batch summary: Get the batches with Legal Entity Id description: 'This method gets all the batches linked to a Legal Entity Id and Tenant Id. The method returns the batch array. Required permissions: Following permissions are required: ScreeningAccess' operationId: getApiV3BatchLegalentityByLegalEntityId parameters: - name: legalEntityId in: path description: The Id of the Legal Entity required: true schema: type: string - name: onlyWithTrueMatches in: query description: Flag to return only the batches with true matches 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 batches are returned content: application/json: schema: $ref: '#/components/schemas/LegalEntityBatchDtoIEnumerableServiceResponse' '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 Legal Entity couldn't 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: GetBatchesByLegalEntityId servers: - url: /screeningquery /api/v4/batch/{id}: get: tags: - Batch summary: Get data of an existing batch with batch Id description: 'This method gets all the batch data for a given batch Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchByIdV4 parameters: - name: id in: path description: The Id of the existing batch to get 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 batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoV2ServiceResponse' '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 batch couldn't 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/journey/{journeyId}: get: tags: - Batch summary: Get data of an existing batch with journey Id description: 'This method gets all the batch data linked to a journey Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchByJourneyIdV4 parameters: - name: journeyId in: path description: The Id of the journey 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoV2ServiceResponse' '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 batch couldn't 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/journey/{journeyId}/process/{processId}: get: tags: - Batch summary: Get data of an existing batch with journey Id and process Id description: 'This method gets all the batch data linked to a journey Id, process Id and tenant Id. The method returns the batch object. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchByJourneyAndProcessIdV4 parameters: - name: journeyId in: path description: The Id of the journey required: true schema: type: string - name: processId in: path description: The Id of the process that started the batch 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. The batch data is returned content: application/json: schema: $ref: '#/components/schemas/BatchDtoV2ServiceResponse' '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 batch couldn't 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/legalentity/{legalEntityId}: get: tags: - Batch summary: Get the batches with Legal Entity Id description: 'This method gets all the batches linked to a Legal Entity Id and Tenant Id. The method returns the batch array. Required permissions: Following permissions are required: ScreeningAccess' operationId: GetBatchesByLegalEntityIdV4 parameters: - name: legalEntityId in: path description: The Id of the Legal Entity required: true schema: type: string - name: onlyWithTrueMatches in: query description: Flag to return only the batches with true matches 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 batches are returned content: application/json: schema: $ref: '#/components/schemas/LegalEntityBatchDtoIEnumerableServiceResponse' '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 Legal Entity couldn't 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/entity/{entityId}/materiality-assessment-history: get: tags: - Batch summary: Get the materiality assessment history for a specific entity description: 'Required permissions: Following permissions are required: ScreeningAccess' operationId: GetEntityMaterialityAssessmentHistory parameters: - name: entityId in: path description: The 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 materiality assessment history is returned (empty array if entity exists but has no history) content: application/json: schema: $ref: '#/components/schemas/BatchEntityMaterialityHistoryDtoIEnumerableServiceResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '403': description: Forbidden. Feature not enabled or missing 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 with the specified ID doesn't exist 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: PropertyDto: type: object properties: type: allOf: - $ref: '#/components/schemas/PropertyType' readOnly: true additionalProperties: false ClassificationDataDto: type: object properties: singleProperties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ClassificationDataSinglePropertyDto' additionalProperties: false BatchCreatedDto: type: object properties: batchId: 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: 12be5a50-66c2-44bb-851e-afc4fc4a28c2 additionalProperties: false description: Represents the data of a batch that has been created UpdateMatchDto: required: - reason - status type: object properties: matchId: type: string description: The unique ID for the match on a Legal Entity. A single entity can have no matches or more than one match. format: uuid example: 7d8a7aae-e78f-4acd-8a18-e60454979809 status: minLength: 1 type: string description: The match status. This will be match/no match/unresolved example: Match reason: minLength: 1 type: string description: Connected to the match status example: Matched Entity classificationData: allOf: - $ref: '#/components/schemas/ClassificationDataDto' description: Classification Data for Matched Result. This is Dictionary to store Data specified as per policy. classificationDataReviewed: type: - boolean - 'null' description: Indicates whether the classification data for this match has been reviewed/confirmed by a user. comments: type: - string - 'null' description: Any additional comments example: Some comments additionalProperties: false description: Represents the match in the UpdateEntityMatches request UpdateMaterialityAssessmentDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateMaterialityAssessmentDto' description: Represents the materiality assessment of a related party additionalProperties: false 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 ClassificationDataSinglePropertyDto: type: object properties: value: type: - string - 'null' label: type: - string - 'null' 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 UpdateMaterialityAssessmentDto: required: - properties type: object properties: relatedPartyEntityId: type: string description: The Entity ID for the related party. format: uuid example: 7d8a7aae-e78f-4acd-8a18-e60454979809 properties: type: object additionalProperties: $ref: '#/components/schemas/PropertyDto' description: Materiality assessment properties additionalProperties: false description: Represents the materiality assessment of a related party 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 ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateBatchDto: required: - entities type: object properties: entities: type: array items: $ref: '#/components/schemas/CreateBatchEntityDto' description: The list of entities that are included in the batch screening search request journeyId: type: - string - 'null' description: The unique Fen-X identifier for the journey that the screening relates to example: 6b8bc209-bd61-4889-8111-a14f262b58af processId: type: - string - 'null' description: The unique Fen-X identifier for the process in the journey that the screening relates to example: eda503d7-cca9-4e87-8e36-537ee864cabc providers: type: - array - 'null' items: $ref: '#/components/schemas/CreateBatchProviderDto' description: 'The list of providers that will be used in the batch. If this property is not set, is null or is an empty array, then the providers used in the batch will be the ones that are active in the Screening configuration of the tenant' additionalProperties: false description: Represents the create batch request CreateBatchDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateBatchDto' description: Represents the create batch request additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BatchCreatedDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/BatchCreatedDto' description: Represents the data of a batch that has been created messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false PropertyType: enum: - Single - Custom - Collection type: string CreateBatchEntityDto: required: - searchCriteria type: object properties: legalEntityId: type: - string - 'null' description: The unique ID for 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 create batch request CreateBatchProviderDto: required: - providerId type: object properties: providerId: minLength: 1 type: string description: The unique ID of the provider. Must match an existing provider in the Screening configuration of the tenant example: ProviderId configurationSetId: type: - string - 'null' description: 'The unique ID of the configuration set within the provider specified in the "ProviderId" property that will be used in the batch. If this property is not set, then the default configuration set of the provider will be used' format: uuid additionalProperties: false description: Represents a provider within the context of a create batch request UpdateEntityMatchesDto: required: - matches type: object properties: entityId: type: string description: The unique Entity ID format: uuid matches: type: array items: $ref: '#/components/schemas/UpdateMatchDto' description: The list of matches additionalProperties: false description: Represents the entity in the UpdateEntityMatches request UpdateEntityMatchesDtoListServiceRequest: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/UpdateEntityMatchesDto' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UploadEntityDocumentDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UploadEntityDocumentDto' description: Request body for initiating an entity document upload. additionalProperties: false EscalateMaterialityAssessmentTaskDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EscalateMaterialityAssessmentTaskDto' description: Represents a request to escalate a materiality task within a batch for second-line review additionalProperties: false UploadMatchDocumentDto: allOf: - $ref: '#/components/schemas/UploadDocumentDtoBase' - type: object additionalProperties: false description: Request body for initiating a match document upload. ReuseEntityDocumentDto: allOf: - $ref: '#/components/schemas/ReuseDocumentDtoBase' - type: object additionalProperties: false description: Request body for reusing an existing entity document from another batch. UploadEntityDocumentResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UploadEntityDocumentResponseDto' description: Response DTO returned after initiating an entity document upload. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ReuseMatchDocumentResponseDto: type: object properties: documentId: type: string description: The internal ID of the newly created document reference in the target batch. format: uuid additionalProperties: false description: Response DTO returned after successfully reusing a match document. ReuseDocumentDtoBase: required: - documentId - reuseFromBatchId type: object properties: documentId: type: string description: The internal ID of the document to reuse. format: uuid reuseFromBatchId: type: string description: The ID of the batch to reuse the document from. format: uuid additionalProperties: false description: Base class for reuse document request DTOs, carrying the shared required fields. ReuseEntityDocumentResponseDto: type: object properties: documentId: type: string description: The internal ID of the newly created document reference in the target batch. format: uuid additionalProperties: false description: Response DTO returned after successfully reusing an entity document. UploadMatchDocumentResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/UploadMatchDocumentResponseDto' description: Response DTO returned after initiating a match document upload. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false CreateBatchDtoV3: required: - entities type: object properties: entities: type: array items: $ref: '#/components/schemas/CreateBatchEntityDtoV3' description: The list of entities that are included in the batch screening search request journeyId: type: - string - 'null' description: The unique Fen-X identifier for the journey that the screening relates to example: 6b8bc209-bd61-4889-8111-a14f262b58af journeyMainLegalEntityName: type: - string - 'null' description: 'The display name of the main legal entity in the batch. Used to populate the "Client" column on the Screening Outcomes grid when the root entity is not itself a screened entity.' processId: type: - string - 'null' description: The unique Fen-X identifier for the process in the journey that the screening relates to example: eda503d7-cca9-4e87-8e36-537ee864cabc providers: type: - array - 'null' items: $ref: '#/components/schemas/CreateBatchProviderDto' description: 'The list of providers that will be used in the batch. If this property is not set, is null or is an empty array, then the providers used in the batch will be the ones that are active in the Screening configuration of the tenant' additionalProperties: false EntityMaterialityAssessmentResultDto: type: object properties: jurisdictions: type: - array - 'null' items: type: string description: 'The jurisdictions that are relevant to the materiality assessment, which may have influenced the decision. It should be only populated when the MaterialityStatus is "Material" to provide context on which jurisdictions contributed to the materiality decision' materialityStatus: type: - string - 'null' description: Indicates the overall result of the assessment additionalProperties: false description: Represents the result of a materiality assessment. UploadMatchDocumentResponseDto: type: object properties: documentId: type: string description: The internal ID of the newly created document reference. format: uuid externalDocumentId: type: string description: The external document ID assigned by the Document Management system. format: uuid signedUrl: type: - string - 'null' description: The pre-signed URL to upload the file content. Null on idempotent replay. additionalProperties: false description: Response DTO returned after initiating a match document upload. FinalMaterialityResultDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/FinalMaterialityResultDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false UpdateBatchEntityDto: type: object properties: entityMaterialityAssessment: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentDto' description: 'Represents the materiality assessment details for a batch entity, including materiality assessment results for PEP, sanctions, adverse media, enforcements, and other relevant factors.' impactedClients: type: - array - 'null' items: $ref: '#/components/schemas/ImpactedClientDto' additionalProperties: false description: Represents a request to update BatchEntity properties 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 journeyTaskId: type: - string - 'null' rationale: type: - string - 'null' description: The rationale behind the materiality assessment decision, providing context and justification for the results. 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.' FinalMaterialityResultDto: type: object properties: finalMaterialityPEP: type: - string - 'null' finalMaterialitySanctions: type: - string - 'null' finalMaterialityAdverseMedia: type: - string - 'null' finalMaterialityEnforcements: type: - string - 'null' finalMaterialityOther: type: - string - 'null' overallMateriality: type: - string - 'null' additionalProperties: false ReuseMatchDocumentDto: allOf: - $ref: '#/components/schemas/ReuseDocumentDtoBase' - required: - reuseFromMatchId type: object properties: reuseFromMatchId: type: string description: The ID of the match in the source batch to reuse the document from. format: uuid additionalProperties: false description: Request body for reusing an existing match document from another batch. UpdateBatchEntityDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateBatchEntityDto' description: Represents a request to update BatchEntity properties additionalProperties: false CreateBatchEntityDtoV3: required: - searchCriteria type: object properties: legalEntityId: type: - string - 'null' description: The unique ID for 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 ReuseMatchDocumentDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReuseMatchDocumentDto' description: Request body for reusing an existing match document from another batch. additionalProperties: false 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 ReuseEntityDocumentDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ReuseEntityDocumentDto' description: Request body for reusing an existing entity document from another batch. additionalProperties: false 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: Mandatory 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.' ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} UploadEntityDocumentResponseDto: type: object properties: documentId: type: string description: The internal ID of the newly created document reference. format: uuid externalDocumentId: type: string description: The external document ID assigned by the Document Management system. format: uuid signedUrl: type: - string - 'null' description: The pre-signed URL to upload the file content. Null on idempotent replay. additionalProperties: false description: Response DTO returned after initiating an entity document upload. CreateBatchDtoV3ServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/CreateBatchDtoV3' additionalProperties: false ReuseEntityDocumentResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ReuseEntityDocumentResponseDto' description: Response DTO returned after successfully reusing an entity document. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ReuseMatchDocumentResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/ReuseMatchDocumentResponseDto' description: Response DTO returned after successfully reusing a match document. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EntityMaterialityAssessmentSanctionsResultDto: type: object properties: jurisdictions: type: - array - 'null' items: type: string description: 'The jurisdictions that are relevant to the materiality assessment, which may have influenced the decision. It should be only 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 should be only populated when the MaterialityStatus is "Material" to provide guidance on whether the entity can proceed despite being deemed material due to sanctions concerns.' materialityStatus: type: - string - 'null' description: Indicates the overall result of the assessment rationale: type: - string - 'null' description: 'The rationale behind the materiality assessment decision, providing context and justification for the results. It should be only 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. UploadDocumentDtoBase: required: - documentType - fileName type: object properties: fileName: minLength: 1 type: string description: The file name of the document to upload. documentType: minLength: 1 type: string description: The document type classification. friendlyName: type: - string - 'null' description: An optional human-friendly display name for the document. idempotencyKey: type: - string - 'null' description: An optional idempotency key to prevent duplicate uploads. additionalProperties: false description: Base class for upload document request DTOs, carrying the shared required fields. UploadMatchDocumentDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UploadMatchDocumentDto' description: Request body for initiating a match document upload. additionalProperties: false EscalateMaterialityAssessmentTaskDto: required: - comment - teamId type: object properties: teamId: type: string description: The ID of the team to escalate to format: uuid example: 7d8a7aae-e78f-4acd-8a18-e60454979809 userId: type: - string - 'null' description: The ID of the user to escalate to example: user-123 comment: minLength: 1 type: string description: The reason or comment for the escalation example: Requires second-line review due to high-risk indicators additionalProperties: false description: Represents a request to escalate a materiality task within a batch for second-line review UploadEntityDocumentDto: allOf: - $ref: '#/components/schemas/UploadDocumentDtoBase' - type: object additionalProperties: false description: Request body for initiating an entity document upload. BatchExternalIdDto: type: object properties: source: type: - string - 'null' description: The source of this externalId (LN, WCO, etc) example: MyProviderId 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) BatchMetadataDto: type: object properties: sourceEventCorrelationId: type: - string - 'null' description: The correlation ID of the source event that triggered this batch autonomyLevel: type: - string - 'null' description: 'Depending on the value, the matches will be auto-resolved using an AI Agent when they come back from the provider, and auto-close the Screening Results task. Possible values: Manual, Semi-Autonomous, Fully Autonomous' totalMatchesForProvider: type: - integer - 'null' description: Total count of all matches for the provider (regardless of status). Used for OGS batches to track match count for screening agent validation. format: int32 additionalProperties: false description: Represents metadata associated with a screening batch BatchProviderDto: required: - id - status type: object properties: id: minLength: 1 type: string description: The unique ID for the provider. A batch can contain results from one or more providers. example: 42fc9261-6343-4fb0-aea1-6023645ff84f status: minLength: 1 type: string description: The status of the specific provider. example: Search Completed errorDetails: allOf: - $ref: '#/components/schemas/AdapterResponseErrorDetailsDto' description: Error details in case something goes wrong during the batch processing. configurationSetId: type: - string - 'null' description: 'The unique ID of the configuration set within the provider specified in the "Id" property that will be used in the batch. If this property is not set, then the default configuration set of the provider will be used' format: uuid additionalProperties: false description: Represents a Provider in a Screening batch 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 LegalEntityBatchDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LegalEntityBatchDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BatchEntitySearchDto: 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 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 additionalProperties: false description: Represents an Entity in a Screening batch LegalEntityBatchDto: required: - batchStatus - batchType - providers type: object properties: batchId: type: string description: The unique ID for the batch. format: uuid example: 42fc9261-6343-4fb0-aea1-6023645ff84f batchType: minLength: 1 type: string description: Type of the batch example: On Demand Screening batchStatus: minLength: 1 type: string description: Batch status example: Closed providers: type: array items: $ref: '#/components/schemas/BatchProviderDto' description: Active providers and their statuses materialMatchesCount: type: integer description: Number of matches in the batch with status Match format: int32 example: 5 batchClosedDate: type: - string - 'null' description: Date when the batch was closed format: date-time example: '2021-01-05T14:48:00.000Z' transactionId: type: - string - 'null' description: Id of the transaction that generated this Screening journey. additionalProperties: false description: Represents a Batch in the GetBatchesByLegalEntityId request BatchDto: required: - batchType - entities - externalIds - providers - reviewDecision - status 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: 12be5a50-66c2-44bb-851e-afc4fc4a28c2 entities: type: array items: $ref: '#/components/schemas/BatchEntitySearchDto' description: List of entities totalEntities: type: integer description: Total number of entities format: int32 example: 1 totalAdverseMedia: type: integer description: Total number of Adverse Media Sanctions format: int32 example: 1 reviewDecision: minLength: 1 type: string description: Review Decision example: Decision reviewReason: type: - string - 'null' description: Reason for review decision example: Reason totalSanctions: type: integer description: Total number of sanctions format: int32 example: 1 reviewComments: type: - string - 'null' description: Review comments example: Comments totalPEPs: type: integer description: Total number of politically exposed person sanctions format: int32 example: 0 totalScreeningsCompleted: type: integer description: Total number of screenings format: int32 example: 1 status: minLength: 1 type: string description: Status. It can be Open, Closed or Overridden example: Open providers: type: array items: $ref: '#/components/schemas/BatchProviderDto' description: Active providers and their statuses externalIds: type: array items: $ref: '#/components/schemas/BatchExternalIdDto' description: ExternalIDs fetched from the providers batchType: minLength: 1 type: string description: Batch type example: On Demand Screening createdDate: type: - string - 'null' description: Date when the batch was created format: date-time example: '2021-01-05T14:48:00.000Z' closedDate: type: - string - 'null' description: Date when the batch was closed format: date-time example: '2021-01-05T16:48:00.000Z' overriddenBatchIds: type: - array - 'null' items: type: string format: uuid description: Ids of the batches that were overridden (for the same Journey) when this batch was created. journeyId: type: - string - 'null' description: Id of the journey this batch was created on. example: eb8fd3fd-2944-448d-995c-5318af6bfbc4 processId: type: - string - 'null' description: Id of the process this batch belongs to. example: 43af6a23-f999-42c6-8200-cf24838ad765 transactionId: type: - string - 'null' description: Id of the transaction that generated the Screening journey. example: 7e8b6f12-7541-4ae7-8081-f73226713073 trueMatchesCount: type: integer description: Number of matches in the batch with status Match format: int32 example: 5 metadata: allOf: - $ref: '#/components/schemas/BatchMetadataDto' description: Metadata associated with the batch additionalProperties: false description: Represents a Screening batch 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 AdapterResponseErrorDetailsDto: required: - errorCode - source type: object properties: source: minLength: 1 type: string description: 'Source where the error was originated, some possible values are: "Unknown", "Invoker", "Adapter".' example: Unknown errorCode: minLength: 1 type: string description: 'Error code: NotSpecified = "E000" AdapterRejectedTheMessage = "E001" AdapterResponseValidationFailed = "E002"' example: NotSpecified message: type: - string - 'null' description: Error message. example: Error message additionalProperties: false description: Represents the error details in a specific provider BatchDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/BatchDto' description: Represents a Screening batch messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false 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 BatchEntitySearchDto_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 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 additionalProperties: false description: Represents an Entity in a Screening batch 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 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 BatchEntitySearchDto_3: 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 searchCriteria: allOf: - $ref: '#/components/schemas/SearchCriteriaDto_4' 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 additionalProperties: false description: Represents an Entity in a Screening batch SearchCriteriaDto_4: 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_4' 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_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 BatchEntityMaterialityHistoryDto: type: object properties: batchId: type: - string - 'null' description: The batch ID journeyId: type: - string - 'null' description: The journey ID journeyType: type: - string - 'null' description: The journey type journeyMainLegalEntityId: type: - string - 'null' description: The Legal Entity ID of the main entity in the batch journeyMainLegalEntityName: type: - string - 'null' description: The name of the main entity in the batch. Returned as `null` when the current user does not have access to this history record's access layers; in that case the property name appears in RestrictedFields. journeyName: type: - string - 'null' description: The name of the journey that the screening relates to, captured at the time the materiality assessment was recorded. entityMaterialityAssessment: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentWithTrueMatchesDto' description: The entity materiality assessment with true match snapshots journeyAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayersDto' description: The access layers (geographic and business-related) controlling visibility of this history record. Sourced from the batch (i.e. the journey context) at the time the materiality snapshot was written. entityAccessLayers: allOf: - $ref: '#/components/schemas/AccessLayersDto' description: The current access layers (geographic and business-related) of the journey's main legal entity for this record. Sourced live from that entity, so the value can differ across records when different journeys have different main entities. restrictedFields: type: - array - 'null' items: type: string description: Names of properties on this record whose values have been hidden (returned as `null`) because the current user is not authorized to see them. Empty when nothing is restricted. additionalProperties: false description: DTO for entity materiality assessment history AccessLayersDto: type: object properties: geographic: type: - array - 'null' items: type: string description: 'The geographic access layers (e.g. country or regional groupings) that can access the resource. Defaults to `["Global"]` when none are specified.' businessRelated: type: - array - 'null' items: type: string description: 'The business-related access layers (e.g. business lines or divisions) that can access the resource. Defaults to `["Enterprise"]` when none are specified.' additionalProperties: false description: Represents the access layer configuration controlling visibility of a resource. EntityMaterialityAssessmentResultDto_2: 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. EntityAliasDto_5: 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 EntityMaterialityAssessmentMatchDto: type: object properties: matchId: type: string description: The ID of the source match. format: uuid name: type: - string - 'null' description: The matched entity name, sourced from the match data. entityUniqueId: type: - string - 'null' description: The provider's unique entity identifier. classificationData: allOf: - $ref: '#/components/schemas/ClassificationDataDto' description: The classification data of the match at the time of capture. providerId: type: - string - 'null' description: The external provider identifier at the time of capture. additionalProperties: false description: 'Represents a point-in-time snapshot of a match that influenced the materiality decision at the moment the Fenergo.Nebula.Screening.Query.Application.Dto.EntityMaterialityAssessmentDto was recorded.' BatchEntitySearchDtoV2: 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 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_5' description: The list of aliases for the entity that will be used to perform screening request additionalProperties: false description: Represents an Entity in a Screening batch EntityMaterialityAssessmentDto_2: type: object properties: pep: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto_2' description: The materiality assessment result for Pep sanctions: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentSanctionsResultDto_2' description: The materiality assessment result for Sanctions adverseMedia: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto_2' description: The materiality assessment result for AdverseMedia enforcements: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto_2' description: The materiality assessment result for Enforcements other: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentResultDto_2' 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.' BatchDtoV2: required: - batchType - entities - externalIds - providers - status 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: 12be5a50-66c2-44bb-851e-afc4fc4a28c2 entities: type: array items: $ref: '#/components/schemas/BatchEntitySearchDtoV2' description: List of entities totalEntities: type: integer description: Total number of entities format: int32 example: 1 status: minLength: 1 type: string description: Status. It can be Open, Closed or Overridden example: Open providers: type: array items: $ref: '#/components/schemas/BatchProviderDto' description: Active providers and their statuses externalIds: type: array items: $ref: '#/components/schemas/BatchExternalIdDto' description: ExternalIDs fetched from the providers batchType: minLength: 1 type: string description: Batch type example: On Demand Screening createdDate: type: - string - 'null' description: Date when the batch was created format: date-time example: '2021-01-05T14:48:00.000Z' closedDate: type: - string - 'null' description: Date when the batch was closed format: date-time example: '2021-01-05T16:48:00.000Z' overriddenBatchIds: type: - array - 'null' items: type: string format: uuid description: Ids of the batches that were overridden (for the same Journey) when this batch was created. journeyId: type: - string - 'null' description: Id of the journey this batch was created on. example: eb8fd3fd-2944-448d-995c-5318af6bfbc4 journeyType: type: - string - 'null' description: 'Type of the journey this batch was created on (e.g. Client Onboarding, Maintenance, etc.) Null when no journey type was specified at creation time.' example: Client Onboarding journeyMainLegalEntityId: type: - string - 'null' description: 'The Legal Entity ID of the main entity in the batch. Null when no main entity was specified at creation time.' processId: type: - string - 'null' description: Id of the process this batch belongs to. example: 43af6a23-f999-42c6-8200-cf24838ad765 transactionId: type: - string - 'null' description: Id of the transaction that generated the Screening journey. example: 7e8b6f12-7541-4ae7-8081-f73226713073 trueMatchesCount: type: integer description: Number of matches in the batch with status Match format: int32 example: 5 metadata: allOf: - $ref: '#/components/schemas/BatchMetadataDto' description: Metadata associated with the batch additionalProperties: false description: Represents a Screening batch EntityMaterialityAssessmentWithTrueMatchesDto: type: object properties: assessment: allOf: - $ref: '#/components/schemas/EntityMaterialityAssessmentDto_2' description: The materiality assessment details. trueMatches: type: - array - 'null' items: $ref: '#/components/schemas/EntityMaterialityAssessmentMatchDto' description: A point-in-time snapshot of the matches that had status "Match" when the batch was closed. additionalProperties: false description: 'DTO that combines a materiality assessment with the point-in-time true match snapshots. Used exclusively by Fenergo.Nebula.Screening.Query.Application.Dto.BatchEntityMaterialityHistoryDto.' BatchEntityMaterialityHistoryDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/BatchEntityMaterialityHistoryDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AddressDto_5: 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 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_5' 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 BatchDtoV2ServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/BatchDtoV2' description: Represents a Screening batch messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EntityMaterialityAssessmentSanctionsResultDto_2: 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-screeningcommand-v1-0-openapi.json - fenergo-screeningcommand-v2-0-openapi.json - fenergo-screeningcommand-v3-0-openapi.json - fenergo-screeningquery-v1-0-openapi.json - fenergo-screeningquery-v2-0-openapi.json - fenergo-screeningquery-v3-0-openapi.json - fenergo-screeningquery-v4-0-openapi.json