{
"openapi": "3.0.1",
"info": {
"title": "Fenergo Nebula Screening Query",
"description": "**Screening Query API**:\n\n
Screening Query API retrieves screening results for screened clients and their associated parties. Use Screening Command API to perform the screening action and Screening Query API to retrieve screening results.\n\n
**Screening Query API Provides**:\n\n
- The ability to retrieve screening results for all entities within a given batch of Legal Entities. batchID + tenant can be used to retrieve screening results of all entities within a given batch.
- The ability to retrieve batch data for a batch of Legal Entities. BatchID + tenant **OR** journeyID + tenant can be used to retrieve results for a batch of screened Legal Entities.
- The ability to retrieve screening results for a single entity within a given batch of Legal Entities. EntityID + batchID + tenant can be used to retrieve screening results for a given entity.
- The ability to retrieve screening results for all matches of a given entity. EntityID + batchID + tenant can be used to retrieve screening results that match the given entity.
- The ability to retrieve screening results for matches of a given match ID. EntityID + batchID + matchID + tenant can be used to retrieve screening results that match the given match ID.",
"version": "2.0"
},
"servers": [
{
"url": "/screeningquery"
}
],
"paths": {
"/api/v2/batch/{id}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get data of an existing batch with batch Id",
"description": "\nThis method gets all the batch data for a given batch Id and tenant Id.\r\n\nThe 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"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/journey/{journeyId}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get data of an existing batch with journey Id",
"description": "\nThis method gets all the batch data linked to a journey Id and tenant Id.\r\n\nThe 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"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/journey/{journeyId}/process/{processId}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get data of an existing batch with journey Id and process Id",
"description": "\nThis method gets all the batch data linked to a journey Id, process Id and tenant Id.\r\n\nThe 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"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/legalentity/{legalEntityId}": {
"get": {
"tags": [
"Batch"
],
"summary": "Get the batches with Legal Entity Id",
"description": "\nThis method gets all the batches linked to a Legal Entity Id and Tenant Id.\r\n\nThe 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"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/{batchId}/entity": {
"get": {
"tags": [
"Entity"
],
"summary": "Get all entities in a batch",
"description": "\nThis method returns all entities for a given batch ID and tenant ID, without including the matches of each entity.\r\n\nThe method returns a list of entity objects.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetEntitiesByBatchIdV2",
"parameters": [
{
"name": "batchId",
"in": "path",
"description": "The ID of the batch the entities belong to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The list of entities is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchEntityDtoV2IEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/{batchId}/entity/{entityId}": {
"get": {
"tags": [
"Entity"
],
"summary": "Get data of an entity",
"description": "\nThis method returns the entity data for a given entity ID, batch ID and tenant ID, without including the matches of the entity.\r\n\nThe method will return the entity object.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetEntityByIdV2",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The ID of the entity",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "batchId",
"in": "path",
"description": "The batch ID the entity belongs to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The entity data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchEntityDtoV2ServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. The entity could not be found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/{batchId}/entity/{entityId}/match": {
"get": {
"tags": [
"Match"
],
"summary": "Get all matches for an entity",
"description": "\nThis method returns all matches for a given entity ID, batch ID and tenant ID.\r\n\nThe method will return a list of match objects.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetMatchesByEntityId",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The ID of the entity the matches belong to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "batchId",
"in": "path",
"description": "The batch ID the entity belongs to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "returnMaterialMatches",
"in": "query",
"description": "Return only matches with status Match",
"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 list of matches is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MatchDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/batch/{batchId}/entity/{entityId}/match/{matchId}": {
"get": {
"tags": [
"Match"
],
"summary": "Get data of a match",
"description": "\nThis method returns the match data for a given match ID, entity ID, batch ID and tenant ID.\r\n\nThe method will return the match object.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetMatchById",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The entity ID the match belongs to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "batchId",
"in": "path",
"description": "The batch ID the entity belongs to",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "matchId",
"in": "path",
"description": "The ID of the match",
"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 match data is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MatchDtoServiceResponse"
}
}
}
},
"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 match could not be found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/scoped-entity/journey/{journeyId}/process/{processId}": {
"get": {
"tags": [
"ScopedEntity"
],
"summary": "Get all entities in scope for Screening for a given Journey and Process",
"description": "\nThis method returns all entities and whether or not they are in scope for Screening for a given Journey and Process.\r\n\nThe method returns a list of scoped entity objects.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetScopedEntitiesByJourneyAndProcessId",
"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 Screening request",
"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 list of entities in scope for Screening is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopedEntityDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server error"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/scoping-rule-set": {
"get": {
"tags": [
"ScopingRuleSet"
],
"summary": "Get all scoping rule sets",
"description": "\nReturns the list of all scoping rule sets.
Required permissions:
Following permissions are required: ScreeningConfigurationAccess",
"operationId": "GetAllScopingRuleSetsLite",
"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"
}
],
"responses": {
"200": {
"description": "Success. The list of lite scoping rule sets is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetLiteDtoIEnumerableServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/scoping-rule-set/{scopingRuleSetId}": {
"get": {
"tags": [
"ScopingRuleSet"
],
"summary": "Get the current scoping rule set version by scopingRuleSetId",
"description": "\nReturns the active, currently in effect, published version of scoping rule set for a given rule set id.
Required permissions:
Following permissions are required: ScreeningConfigurationAccess",
"operationId": "GetCurrentScopingRuleSetVersionByRuleSetId",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. An instance of scoping rule set is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/scoping-rule-set/{scopingRuleSetId}/version/{versionNumber}": {
"get": {
"tags": [
"ScopingRuleSet"
],
"summary": "Get scoping rule set version by scopingRuleSetId and versionNumber",
"description": "\nReturns scoping rule set version for a given id and version number.
Required permissions:
Following permissions are required: ScreeningConfigurationAccess",
"operationId": "GetScopingRuleSetVersionByRuleSetIdAndVersionNumber",
"parameters": [
{
"name": "scopingRuleSetId",
"in": "path",
"description": "Scoping rule set id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "versionNumber",
"in": "path",
"description": "Scoping rule set version number",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. Scoping rule set is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScopingRuleSetVersionDtoServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not Found. Scoping rule set with given id/version does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationErrorModelListServiceResponse"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"403": {
"description": "Access to resource is forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Access denied. Following permissions are required: Permission1, Permission2",
"type": "Forbidden",
"errorCode": "Error Code"
}
]
}
}
}
},
"500": {
"description": "Internal server exception. Please, contact your provider.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "Internal server exception. Please, contact your provider.",
"type": "Error",
"errorCode": "INTERNAL_SERVER_ERROR"
}
]
}
}
}
},
"410": {
"description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StringServiceResponse"
},
"example": {
"data": null,
"messages": [
{
"message": "This endpoint is obsolete and was terminated on yyyy-MM-dd",
"type": "Error",
"errorCode": "OBSOLETE_ENDPOINT"
}
]
}
}
}
}
}
}
},
"/api/v2/entity/{entityId}": {
"get": {
"tags": [
"ScreeningEntity"
],
"summary": "Gets an existing Screening entity by ID",
"description": "\nThis method is used to get the data of an existing Screening entity by ID.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetEntity",
"parameters": [
{
"name": "entityId",
"in": "path",
"description": "The Screening ID of the entity",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"responses": {
"200": {
"description": "Success. The data of the entity is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScreeningEntityDtoServiceResponse"
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectServiceResponse"
},
"example": {
"data": { },
"messages": [
{
"message": "Not found. The entity 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"
}
]
}
}
}
}
}
}
},
"/api/v2/entity/getentitieslist": {
"post": {
"tags": [
"ScreeningEntity"
],
"summary": "Get a list of all screening entities found corresponding to a list of legal entity IDs.",
"description": "\nThis method returns a list of all screening entity objects found corresponding to a given list of legal entity IDs.\r\n\n\r\n\n\r\nPre-requisites:\r\n\n\r\n For a screening entity to be returned for a given legal entity id, it must already exist in the Screening domain.\n\r\n If no screening entity is found for a given legal entity id, it will simply not be included in the response.\r\n The response will contain only the screening entities found.\n\r\n A maximum number of 100 legal entity IDs can be submitted in a single request. To query for more,\r\n please split them into multiple requests.
Required permissions:
Following permissions are required: ScreeningAccess",
"operationId": "GetEntitiesList",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Get entities list request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/GetEntitiesListDtoServiceRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Success. A list of one or more screening entities is returned",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScreeningEntityDtoIEnumerableServiceResponse"
}
}
}
},
"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"
}
]
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AdapterResponseErrorDetailsDto": {
"required": [
"errorCode",
"source"
],
"type": "object",
"properties": {
"source": {
"minLength": 1,
"type": "string",
"description": "Source where the error was originated, some possible values are:\r\n\"Unknown\",\r\n\"Invoker\",\r\n\"Adapter\".",
"example": "Unknown"
},
"errorCode": {
"minLength": 1,
"type": "string",
"description": "Error code:\r\nNotSpecified = \"E000\"\r\nAdapterRejectedTheMessage = \"E001\"\r\nAdapterResponseValidationFailed = \"E002\"",
"example": "NotSpecified"
},
"message": {
"type": "string",
"description": "Error message.",
"nullable": true,
"example": "Error message"
}
},
"additionalProperties": false,
"description": "Represents the error details in a specific provider"
},
"AdditionalInfoDto": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of additional information",
"nullable": true,
"example": "Title"
},
"content": {
"type": "array",
"items": {
"type": "string"
},
"description": "Content of additional information",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents the additional info about the matching entity"
},
"AddressDto": {
"type": "object",
"properties": {
"addressLine1": {
"type": "string",
"description": "The first line in the address",
"nullable": true,
"example": "7107 Andell Rd"
},
"addressLine2": {
"type": "string",
"description": "The second line in the address",
"nullable": true,
"example": "Portobello"
},
"city": {
"type": "string",
"description": "The city",
"nullable": true,
"example": "Dublin"
},
"postalCode": {
"type": "string",
"description": "The postal code",
"nullable": true,
"example": "D08 YY66"
},
"country": {
"type": "string",
"description": "The country",
"nullable": true,
"example": "Ireland"
},
"countryISO2": {
"type": "string",
"description": "The country ISO2 code",
"nullable": true,
"example": "IE"
},
"countryISO3": {
"type": "string",
"description": "The country ISO3 code",
"nullable": true,
"example": "IRL"
},
"stateProvince": {
"type": "string",
"description": "The state or province",
"nullable": true,
"example": "Leinster"
},
"type": {
"type": "string",
"description": "The type",
"nullable": true,
"example": "Personal"
},
"category": {
"type": "string",
"description": "The category of the address",
"nullable": true,
"example": "Residential"
}
},
"additionalProperties": false,
"description": "Represents the address of an entity"
},
"ApproveAction": {
"type": "object",
"properties": {
"comment": {
"type": "string",
"nullable": true
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/Decision"
}
]
},
"created": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"Approver": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false
},
"AssociationDto": {
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "The unique identifier of the Associated Entity outside of Fen-X (i.e. in the underlying provider).\r\nUsed to query the underlying provider for more information about the associated entity.",
"nullable": true,
"example": "e_tr_wco_2256753"
},
"category": {
"type": "string",
"description": "Category of additional information",
"nullable": true,
"example": "Enforcement:Antitrust Violations"
},
"fullName": {
"type": "string",
"description": "The name of the associated party",
"nullable": true,
"example": "Alphabet Inc."
},
"relationship": {
"type": "string",
"description": "How the entity and the associated party are related i.e shareholder, director",
"nullable": true,
"example": "Co-Defendant"
},
"relationshipGroup": {
"type": "string",
"description": "The relationship group as reported by the underlying provider (e.g. Family, Associations)",
"nullable": true,
"example": "Family"
},
"ownershipPercentage": {
"type": "number",
"description": "The ownership percentage of the associated party, as reported by the underlying provider",
"format": "double",
"nullable": true,
"example": 19.74
}
},
"additionalProperties": false,
"description": "Represents a relationship with another entity"
},
"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",
"description": "Reason for review decision",
"nullable": true,
"example": "Reason"
},
"totalSanctions": {
"type": "integer",
"description": "Total number of sanctions",
"format": "int32",
"example": 1
},
"reviewComments": {
"type": "string",
"description": "Review comments",
"nullable": true,
"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",
"description": "Date when the batch was created",
"format": "date-time",
"nullable": true,
"example": "2021-01-05T14:48:00.000Z"
},
"closedDate": {
"type": "string",
"description": "Date when the batch was closed",
"format": "date-time",
"nullable": true,
"example": "2021-01-05T16:48:00.000Z"
},
"overriddenBatchIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Ids of the batches that were overridden (for the same Journey) when this batch was created.",
"nullable": true
},
"journeyId": {
"type": "string",
"description": "Id of the journey this batch was created on.",
"nullable": true,
"example": "eb8fd3fd-2944-448d-995c-5318af6bfbc4"
},
"processId": {
"type": "string",
"description": "Id of the process this batch belongs to.",
"nullable": true,
"example": "43af6a23-f999-42c6-8200-cf24838ad765"
},
"transactionId": {
"type": "string",
"description": "Id of the transaction that generated the Screening journey.",
"nullable": true,
"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",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a Screening batch"
},
"BatchDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BatchDto"
}
],
"description": "Represents a Screening batch",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"BatchEntityDtoV2": {
"required": [
"searchCriteria"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID for the batch of entities to be screened. A batch can contain one or more entities.",
"format": "uuid",
"example": "42fc9261-6343-4fb0-aea1-6023645ff84f"
},
"legalEntityId": {
"type": "string",
"description": "The unique ID for a Legal Entity in Fen-X",
"nullable": true,
"example": "09470796-da15-4054-a61d-8667d2f03b8a"
},
"entityName": {
"type": "string",
"description": "Full Company name",
"nullable": true,
"example": "CompanyName"
},
"externalIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalIdDto"
},
"description": "ExternalIDs fetched from the providers",
"nullable": true
},
"searchCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/SearchCriteriaDto"
}
],
"description": "Search criteria specified in the request for the entity"
},
"entityAliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityAliasDto"
},
"description": "The list of aliases for the entity that will be used to perform screening request",
"nullable": true
},
"materialityAssessment": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"nullable": true
},
"description": "Materiality assessment dynamic properties",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a Batch Entity V2"
},
"BatchEntityDtoV2IEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchEntityDtoV2"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"BatchEntityDtoV2ServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/BatchEntityDtoV2"
}
],
"description": "Represents a Batch Entity V2",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"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",
"description": "The unique ID for a Legal Entity in Fen-X",
"nullable": true,
"example": "09470796-da15-4054-a61d-8667d2f03b8a"
},
"searchCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/SearchCriteriaDto"
}
],
"description": "Search criteria specified in the request for the entity"
},
"entityAliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityAliasDto"
},
"description": "The list of aliases for the entity that will be used to perform screening request",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents an Entity in a Screening batch"
},
"BatchExternalIdDto": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of this externalId (LN, WCO, etc)",
"nullable": true,
"example": "MyProviderId"
},
"name": {
"type": "string",
"description": "The name of the ID in the provider",
"nullable": true,
"example": "FieldInProvider"
},
"value": {
"type": "string",
"description": "The value of the ID",
"nullable": true,
"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",
"description": "The correlation ID of the source event that triggered this batch",
"nullable": true
},
"autonomyLevel": {
"type": "string",
"description": "Depending on the value, the matches will be auto-resolved using an AI Agent when they come back from the provider,\r\nand auto-close the Screening Results task. Possible values: Manual, Semi-Autonomous, Fully Autonomous",
"nullable": true
},
"totalMatchesForProvider": {
"type": "integer",
"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",
"nullable": true
}
},
"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.",
"nullable": true
},
"configurationSetId": {
"type": "string",
"description": "The unique ID of the configuration set within the provider specified in the \"Id\" property that will be\r\nused in the batch.\r\nIf this property is not set, then the default configuration set of the provider will be used",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a Provider in a Screening batch"
},
"CollectionDto": {
"type": "object",
"properties": {
"properties": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Data Group properties",
"nullable": true
}
},
"additionalProperties": false,
"description": "Contains Data Group object which have specified properties"
},
"CollectionPropertyDto": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyDto"
},
{
"type": "object",
"properties": {
"dataGroupId": {
"type": "string",
"description": "Gets or sets the custom type identifier.",
"format": "uuid",
"example": "77eff80a-533c-4989-b53f-0c2bd1fa8790"
},
"collections": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/CollectionDto"
},
"description": "The collections of Data Groups",
"nullable": true
}
},
"additionalProperties": false
}
],
"description": "Contains Data Group objects which are a collection of specific type"
},
"ConditionDefinitionDto": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"nullable": true
},
"value": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"valueId": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"valueType": {
"type": "string",
"nullable": true
},
"dataSource": {
"type": "string",
"nullable": true
},
"operation": {
"type": "string",
"nullable": true
},
"logicalOperation": {
"type": "string",
"nullable": true
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"nullable": true
},
"valueField": {
"allOf": [
{
"$ref": "#/components/schemas/ValueField"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ConditionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"logicalOperation": {
"type": "string",
"nullable": true
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"ConditionalValueDto": {
"allOf": [
{
"$ref": "#/components/schemas/StringConditionalValueDto"
},
{
"type": "object",
"properties": {
"valueId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"ConditionalValueDto`1": {
"allOf": [
{
"$ref": "#/components/schemas/ConditionDto"
},
{
"type": "object",
"properties": {
"value": {
"allOf": [
{
"$ref": "#/components/schemas/T"
}
],
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
]
},
"CustomPropertyDto": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyDto"
},
{
"type": "object",
"properties": {
"customTypeId": {
"type": "string",
"description": "Unique Id",
"format": "uuid",
"example": "4485a32d-f67c-494d-a820-9031f8236c6a"
},
"value": {
"type": "string",
"description": "Unique Id",
"nullable": true,
"example": "PropertyValue"
},
"properties": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/PropertyDto"
},
"description": "Collections of properties",
"nullable": true
}
},
"additionalProperties": false
}
],
"description": "Represents custom materiality assessment properties"
},
"Decision": {
"enum": [
"Approve",
"Reject"
],
"type": "string"
},
"EntityAliasDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the entity alias, which in FenX is the id of the Alternate Names DataGroup item.",
"nullable": true,
"example": "12be5a50-66c2-44bb-851e-afc4fc4a28c2"
},
"aliasType": {
"type": "string",
"description": "The type of the alias",
"nullable": true,
"example": "Also Known As"
},
"fullName": {
"type": "string",
"description": "The Individual's firstname and surname. Alternatively use FirstName with LastName.",
"nullable": true,
"example": "John Doe"
},
"firstName": {
"type": "string",
"description": "The Individual's first name. Alternatively use FullName.",
"nullable": true,
"example": "John"
},
"middleName": {
"type": "string",
"description": "The Individual's middle name",
"nullable": true,
"example": "David"
},
"lastName": {
"type": "string",
"description": "The Individual's surname. Alternatively use FullName.",
"nullable": true,
"example": "Doe"
},
"legalEntityName": {
"type": "string",
"description": "Full Company name",
"nullable": true,
"example": "Fenergo"
}
},
"additionalProperties": false,
"description": "Class to represent a Screening entity Alias"
},
"ExternalIdDto": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "The source of this externalId (LN, WCO, etc)",
"nullable": true,
"example": "MyProviderId"
},
"entityAliasId": {
"type": "string",
"description": "What entity Alias this externalId is associated with. Will be null or \"PrimaryName\" for the PrimaryName external ids",
"nullable": true,
"example": "e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e"
},
"name": {
"type": "string",
"description": "The name of the ID in the provider",
"nullable": true,
"example": "FieldInProvider"
},
"value": {
"type": "string",
"description": "The value of the ID",
"nullable": true,
"example": "1234"
}
},
"additionalProperties": false,
"description": "Dto to represent the external IDs fetched from the providers (runId, resultId, etc)"
},
"GetEntitiesListDto": {
"required": [
"legalEntityIds"
],
"type": "object",
"properties": {
"legalEntityIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of unique legal entity Ids for which the corresponding screening entities should be returned in the GetEntitiesListRequest"
}
},
"additionalProperties": false,
"description": "Class to represent the request for GetEntitiesList"
},
"GetEntitiesListDtoServiceRequest": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/GetEntitiesListDto"
}
],
"description": "Class to represent the request for GetEntitiesList",
"nullable": true
}
},
"additionalProperties": false
},
"HttpValidationProblemDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ProblemDetails"
},
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"nullable": true
}
},
"additionalProperties": { }
}
]
},
"LastActionedByDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the user taht actioned the resolution of the match",
"nullable": true,
"example": "42fc9261-6343-4fb0-aea1-6023645ff84f"
},
"type": {
"type": "string",
"description": "The type of the user that actioned the resolution of the match",
"nullable": true,
"example": "User"
},
"reusedFromPreviousBatch": {
"type": "boolean",
"description": "Used to identify if the user that actioned the resolution of the match is reused from a previous batch"
},
"actionedOn": {
"type": "string",
"description": "The date and time when the match was last actioned (server-generated, UTC).\r\nNull for matches actioned before this field was introduced (March 2026).",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents the details of a screening match"
},
"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",
"description": "Date when the batch was closed",
"format": "date-time",
"nullable": true,
"example": "2021-01-05T14:48:00.000Z"
},
"transactionId": {
"type": "string",
"description": "Id of the transaction that generated this Screening journey.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a Batch in the GetBatchesByLegalEntityId request"
},
"LegalEntityBatchDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LegalEntityBatchDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"MatchDataAliasDto": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value",
"nullable": true,
"example": "TE"
},
"type": {
"type": "string",
"description": "The type",
"nullable": true,
"example": "Acronym"
}
},
"additionalProperties": false,
"description": "Represent the alias of an entity"
},
"MatchDataDto": {
"required": [
"providerId",
"providerSourceName"
],
"type": "object",
"properties": {
"externalId": {
"type": "string",
"description": "The unique identifier of the match outside of Fen-X (i.e. in the underlying provider). \n\r\nIf using Alias Screening, this will be the ExternalId of the first entity in which this match appears.\r\nSo instead of using this field, ExternalIds should be used, as it contains the ExternalId for each of the aliases the match belongs to.",
"nullable": true,
"example": "42fc9261-6343-4fb0-aea1-6023645ff84f"
},
"externalIds": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchDataExternalIdDto"
},
"description": "The unique identifiers of the match outside of Fen-X (i.e. in the underlying provider). \n\r\nThey will be used later on to resolve the matches on the provider side. There will be one (or more) ExternalId\r\nfor each of the entity alias ids related to this match",
"nullable": true
},
"providerId": {
"minLength": 1,
"type": "string",
"description": "The ID of the Provider that returned the match",
"example": "ProviderId"
},
"name": {
"type": "string",
"description": "The name of the matching entity",
"nullable": true,
"example": "Name"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"description": "Any aliases associated with the matching entity, formatted as a list of strings",
"nullable": true,
"deprecated": true
},
"aliasesList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchDataAliasDto"
},
"description": "Any aliases associated with the matching entity, formatted as a list of AliasDto",
"nullable": true
},
"gender": {
"type": "string",
"description": "The Individual's gender",
"nullable": true,
"example": "Male"
},
"dateOfBirth": {
"type": "string",
"description": "The Individual's date of birth in DD/MM/YYYY format",
"nullable": true,
"example": "31/12/1989"
},
"country": {
"type": "string",
"description": "The country",
"nullable": true,
"example": "Ireland"
},
"entityType": {
"type": "string",
"description": "The type of entity i.e. Individual or Company",
"nullable": true,
"example": "Individual"
},
"matchScore": {
"type": "number",
"description": "A confidence score generated by the screening provider to indicate how closely the result record matched the searched entity data.",
"format": "double",
"example": 90
},
"providerSourceName": {
"minLength": 1,
"type": "string",
"description": "The name of the screening provider",
"example": "SourceName"
},
"providerSourceUrl": {
"type": "string",
"description": "URL of the match on the provider side",
"nullable": true,
"example": "www.sourceurl.com"
},
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressDto"
},
"description": "List of addresses of the Individual or Company",
"nullable": true
},
"citizenship": {
"type": "string",
"description": "The Individual's citizenship",
"nullable": true,
"example": "Irish"
},
"nationality": {
"type": "string",
"description": "The Individual's nationality",
"nullable": true,
"example": "Irish"
},
"placeOfBirth": {
"type": "string",
"description": "The Individual's place of birth",
"nullable": true,
"example": "Dublin"
},
"countryOfResidence": {
"type": "string",
"description": "The Individual's country of residence",
"nullable": true,
"example": "Ireland"
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInfoDto"
},
"description": "Additional information about the matching entity",
"nullable": true
},
"sourcesInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalInfoDto"
},
"description": "Contains links related to the result",
"nullable": true
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "The screening category that the result relates to (e.g. PEP, Sanctions, Enforcement, Adverse Media, etc.)",
"nullable": true
},
"sources": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contains links to sources of information related to the result",
"nullable": true
},
"registeredCountry": {
"type": "string",
"description": "The country the Company is registered in",
"nullable": true,
"example": "Ireland"
},
"ids": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "List of Ids returned by the underlying provider",
"nullable": true
},
"associations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociationDto"
},
"description": "List of entities associated to the entity being screened",
"nullable": true
},
"richTextAdditionalDetails": {
"type": "string",
"description": "An optional property to store additional details about the match in rich text format",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents the details of a screening match"
},
"MatchDataExternalIdDto": {
"type": "object",
"properties": {
"entityAliasId": {
"type": "string",
"description": "What entity Alias this externalId is associated with. Will be \"PrimaryName\" for the PrimaryName external ids",
"nullable": true,
"example": "e7b8f7c2-3c4a-4b2a-9e2d-1f2a3b4c5d6e"
},
"value": {
"type": "string",
"description": "The value of the ID",
"nullable": true,
"example": "1234"
}
},
"additionalProperties": false,
"description": "Class to represent a match external id"
},
"MatchDto": {
"type": "object",
"properties": {
"id": {
"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": "6fbfa5f9-124f-4159-b947-d9294ad48370"
},
"entityAliasIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of the Entity AliasIds that this match is associated with. When it's associated with the primary name of the entity, one of them will be \"PrimaryName\".\r\nIf the array is null or empty, it means that the match only belongs to the PrimaryName of the entity.",
"nullable": true
},
"status": {
"type": "string",
"description": "The match status. This will be match/no match/unresolved",
"nullable": true,
"example": "No Match"
},
"reason": {
"type": "string",
"description": "Connected to the match status",
"nullable": true,
"example": "No Name Match"
},
"comments": {
"type": "string",
"description": "Any additional comments",
"nullable": true,
"example": "Additional comments"
},
"matchData": {
"allOf": [
{
"$ref": "#/components/schemas/MatchDataDto"
}
],
"description": "Data related to the match",
"nullable": true
},
"lastActionedBy": {
"allOf": [
{
"$ref": "#/components/schemas/LastActionedByDto"
}
],
"description": "User/System who actioned the match",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represents a Screening Match"
},
"MatchDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MatchDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"MatchDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MatchDto"
}
],
"description": "Represents a Screening Match",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ObjectServiceResponse": {
"type": "object",
"properties": {
"data": {
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"OngoingScreeningProviderDto": {
"required": [
"providerId"
],
"type": "object",
"properties": {
"providerId": {
"minLength": 1,
"type": "string",
"description": "The provider ID.",
"example": "ProviderId"
},
"ongoingScreeningEnabled": {
"type": "boolean",
"description": "If the entity is enabled for Ongoing Screening for the provider.",
"example": true
},
"configurationSetIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The list of configuration set IDs where the entity is subscribed to for ongoing screening (applicable for the\r\nSegregation of Ongoing Screening feature).",
"nullable": true,
"example": [
"76ce4f1a-8676-4d4f-be0f-ae57b99b7e27",
"bb8cd902-1aa8-456e-a22d-a4fc470e8386"
]
}
},
"additionalProperties": false,
"description": "Represents a provider within the context of an entity"
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"PropertyDto": {
"type": "object",
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyType"
}
],
"description": "Type of property.",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Represents materiality assessment properties"
},
"PropertyType": {
"enum": [
"Single",
"Custom",
"Collection"
],
"type": "string"
},
"ScopedEntityDto": {
"required": [
"journeyId",
"legalEntityId",
"processId"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID for the scoped entity",
"format": "uuid",
"example": "12be5a50-66c2-44bb-851e-afc4fc4a28c2"
},
"legalEntityId": {
"minLength": 1,
"type": "string",
"description": "The unique ID for a Legal Entity in Fen-X",
"example": "679f501c-632a-474c-aca8-3ab7245d75cd"
},
"journeyId": {
"minLength": 1,
"type": "string",
"description": "The unique Fen-X identifier for the journey that the screening relates to",
"example": "1eac7a8c-35bb-4202-9829-fb86fee9f388"
},
"processId": {
"minLength": 1,
"type": "string",
"description": "The unique Fen-X identifier for the process in the journey that the screening relates to",
"example": "aa8eb381-7457-4581-ad74-cc397e62b18c"
},
"isInScopeByScopingRulesRun": {
"type": "boolean",
"description": "Flag to check if entity is in scope for Screening after running the scoping rules",
"example": true
},
"isInScopeByManualOverride": {
"type": "boolean",
"description": "Flag to check if entity was manually set in scope for Screening",
"nullable": true,
"example": true
}
},
"additionalProperties": false,
"description": "Represents Scoped Entity"
},
"ScopedEntityDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScopedEntityDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScopingRuleSetLiteDto": {
"required": [
"jurisdiction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the scoping rule set",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"jurisdiction": {
"minLength": 1,
"type": "string",
"description": "Scoping rule set jurisdiction",
"example": "Global"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScopingRuleSetLiteVersionDto"
},
"description": "Versions associated to the scoping rule set",
"nullable": true
},
"version": {
"type": "integer",
"description": "Version number for given Aggregate (concurrency check)",
"format": "int32",
"example": 1
}
},
"additionalProperties": false,
"description": "Represents a lite version of a Scoped Entity"
},
"ScopingRuleSetLiteDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScopingRuleSetLiteDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScopingRuleSetLiteVersionDto": {
"required": [
"jurisdiction",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The UiD of the scoping rule set version",
"format": "uuid",
"example": "228313c6-91e6-4b05-a537-5a1ab906418f"
},
"scopingRuleSetId": {
"type": "string",
"description": "The UiD of the scoping rule set that the version belongs to",
"format": "uuid",
"example": "118313c6-91e6-4b05-a537-5a1ab906418f"
},
"name": {
"minLength": 1,
"type": "string",
"description": "Display name of scoping rule set",
"example": "Global Scoping Rules"
},
"jurisdiction": {
"minLength": 1,
"type": "string",
"description": "Scoping rule set jurisdiction",
"example": "Global"
},
"versionNumber": {
"type": "integer",
"description": "The versions number",
"format": "int32",
"example": 1
},
"effectiveFrom": {
"type": "string",
"description": "The date that the version takes effect when published",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"effectiveUntil": {
"type": "string",
"description": "The calculated date that the version ceases being active",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"publicationDate": {
"type": "string",
"description": "The date that the version got published",
"format": "date-time",
"nullable": true,
"example": "2021-01-01T14:48:00.000Z"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VersionStatus"
}
],
"description": "The status of the version",
"example": "Published"
},
"created": {
"type": "string",
"description": "The creation date of the version",
"format": "date-time",
"example": "2021-01-01T14:48:00.000Z"
},
"isActive": {
"type": "boolean",
"description": "The calculated flag to annotate whether this is the model's latest version\r\nat the time of the query (not necessarily published)",
"example": true
},
"version": {
"type": "integer",
"description": "Version number for given Aggregate (concurrency check)",
"format": "int32",
"nullable": true,
"example": 1
}
},
"additionalProperties": false,
"description": "Represents a lite version of a Scoped Entity Version"
},
"ScopingRuleSetVersionDto": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetLiteVersionDto"
},
{
"required": [
"signees"
],
"type": "object",
"properties": {
"signees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SigneeDto"
},
"description": "The defined list of signees for the version"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDto"
},
"description": "Conditions under which the schema can be used",
"nullable": true
}
},
"additionalProperties": false
}
],
"description": "Response DTO representing scoping rule set version data"
},
"ScopingRuleSetVersionDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScopingRuleSetVersionDto"
}
],
"description": "Response DTO representing scoping rule set version data",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScreeningEntityDto": {
"required": [
"searchCriteria"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ID for the entity.",
"format": "uuid",
"example": "e698cac9-4ecb-47a8-94fa-ad27322dcc26"
},
"legalEntityId": {
"type": "string",
"description": "The unique ID for a Legal Entity in Fen-X",
"nullable": true,
"example": "4b061074-a91c-43fa-9743-906dbdfff689"
},
"searchCriteria": {
"allOf": [
{
"$ref": "#/components/schemas/SearchCriteriaDto"
}
],
"description": "The search criteria for the entity"
},
"entityAliases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityAliasDto"
},
"description": "The list of aliases for the entity that will be used to perform screening request",
"nullable": true
},
"providers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OngoingScreeningProviderDto"
},
"description": "The providers used to screen the entity",
"nullable": true
}
},
"additionalProperties": false,
"description": "Represent Screening Entity"
},
"ScreeningEntityDtoIEnumerableServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScreeningEntityDto"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ScreeningEntityDtoServiceResponse": {
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ScreeningEntityDto"
}
],
"description": "Represent Screening Entity",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"SearchCriteriaDto": {
"required": [
"type"
],
"type": "object",
"properties": {
"fullName": {
"type": "string",
"description": "The Individual's firstname and surname. Alternatively use FirstName with LastName.",
"nullable": true,
"example": "John Doe"
},
"firstName": {
"type": "string",
"description": "The Individual's first name. Alternatively use FullName.",
"nullable": true,
"example": "John"
},
"middleName": {
"type": "string",
"description": "The Individual's middle name",
"nullable": true,
"example": "David"
},
"lastName": {
"type": "string",
"description": "The Individual's surname. Alternatively use FullName.",
"nullable": true,
"example": "Doe"
},
"dateOfBirth": {
"type": "string",
"description": "The Individual's date of birth in DD/MM/YYYY format",
"nullable": true,
"example": "31/12/1990"
},
"gender": {
"type": "string",
"description": "The Individual's gender",
"nullable": true,
"example": "Male"
},
"legalEntityName": {
"type": "string",
"description": "Full Company name",
"nullable": true,
"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 or Company",
"nullable": true
},
"idNumber": {
"type": "string",
"description": "The Individual's or Company's ID number",
"nullable": true,
"example": "1234"
},
"phoneNumber": {
"type": "string",
"description": "The Individual's or Company's phone number",
"nullable": true,
"example": "020 7946 0000"
},
"emailAddress": {
"type": "string",
"description": "The Individual's or Company's email address",
"nullable": true,
"example": "john@doe.com"
},
"nationality": {
"type": "string",
"description": "The Individual's nationality",
"nullable": true,
"example": "Irish"
},
"countryOfResidence": {
"type": "string",
"description": "The Individual's country of residence",
"nullable": true,
"example": "Ireland"
},
"placeOfBirth": {
"type": "string",
"description": "The Individual's place of birth",
"nullable": true,
"example": "Dublin"
},
"placeOfBirthISO2": {
"type": "string",
"description": "The Individual's place of birth in country ISO2 code",
"nullable": true,
"example": "IE"
},
"placeOfBirthISO3": {
"type": "string",
"description": "The Individual's place of birth in country ISO3 code",
"nullable": true,
"example": "IRL"
},
"citizenship": {
"type": "string",
"description": "The Individual's citizenship",
"nullable": true,
"example": "Irish"
},
"citizenshipISO2": {
"type": "string",
"description": "The Individual's citizenship in country ISO2 code",
"nullable": true,
"example": "IE"
},
"citizenshipISO3": {
"type": "string",
"description": "The Individual's citizenship in country ISO3 code",
"nullable": true,
"example": "IRL"
},
"registeredCountry": {
"type": "string",
"description": "The country the Company is registered in",
"nullable": true,
"example": "Ireland"
},
"registeredCountryISO2": {
"type": "string",
"description": "The country the Company is registered in ISO2 code",
"nullable": true,
"example": "IE"
},
"registeredCountryISO3": {
"type": "string",
"description": "The country the Company is registered in ISO3 code",
"nullable": true,
"example": "IRL"
},
"subtype": {
"type": "string",
"description": "The subtype of an entity",
"nullable": true,
"example": "Vessel"
},
"uniqueId": {
"type": "string",
"description": "The unique id of an entity that is part of a subtype",
"nullable": true,
"example": "VesselId"
},
"otherInformation": {
"type": "string",
"description": "Other information about an individual or a company",
"nullable": true,
"example": "Information1|Information2|Information3"
},
"passportNumber": {
"type": "string",
"description": "Passport number of the individual",
"nullable": true,
"example": "123456789"
},
"socialSecurityNumber": {
"type": "string",
"description": "Social Security Number (SSN) of the individual",
"nullable": true,
"example": "555-50-1234"
},
"driversLicense": {
"type": "string",
"description": "Driver's License number of the individual",
"nullable": true,
"example": "SMITH580117SM9XJ"
},
"employerIdentificationNumber": {
"type": "string",
"description": "Employer Identification Number (EIN) of the company",
"nullable": true,
"example": "12-3456789"
}
},
"additionalProperties": false,
"description": "Represent the Search Criteria to perform a Screen request"
},
"ServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"ServiceResponseMessage": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"SigneeDto": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"successor": {
"allOf": [
{
"$ref": "#/components/schemas/Approver"
}
],
"nullable": true
},
"action": {
"allOf": [
{
"$ref": "#/components/schemas/ApproveAction"
}
],
"nullable": true
},
"hasProcessedRequest": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false,
"description": "Defines a version Signee"
},
"SinglePropertyDto": {
"allOf": [
{
"$ref": "#/components/schemas/PropertyDto"
},
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Property value",
"nullable": true,
"example": "Material"
},
"isAggregatedValue": {
"type": "boolean",
"description": "Wether the value is aggregated or not",
"example": true
}
},
"additionalProperties": false
}
],
"description": "Represents single materiality assessment properties"
},
"StringConditionalValueDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"logicalOperation": {
"type": "string",
"nullable": true
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionDefinitionDto"
},
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"StringServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "string",
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"T": {
"type": "object",
"additionalProperties": false
},
"ValidationErrorModel": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"attemptedValue": {
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ValidationErrorModelListServiceResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorModel"
},
"nullable": true
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceResponseMessage"
},
"nullable": true
}
},
"additionalProperties": false,
"example": {
"data": [
{
"propertyName": "data",
"errorMessage": "Data is required",
"attemptedValue": "",
"errorCode": "NotNullValidator"
}
],
"messages": [
{
"message": "Data is required",
"type": "Error",
"errorCode": "Error Code"
}
]
}
},
"ValueField": {
"type": "object",
"properties": {
"dataSource": {
"type": "string",
"nullable": true
},
"field": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"VersionStatus": {
"enum": [
"Draft",
"Pending",
"Rejected",
"Published",
"Archived",
"Deleted"
],
"type": "string"
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}