Batch Screening

Get Batch Screening Job

After you have started a screening job, you will receive a job id in the response. ´´´ { "id" : "" } ´´´ Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the results.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Batch Screening Job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

401

Unauthorized

404

Not Found

get/v2/screeningjobs/{id}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "createdAt": "2024-06-20T07:02:22Z",
  • "user": "johndoe",
  • "progress": "77",
  • "auditTrail": {
    }
}

List Screening Results

After a screening job is finished, you can use the job id to iterate over the results using this endpoint ´´´ { "id" : "" } ´´´

SecurityapiKey
Request
path Parameters
id
required
string

ID of the Lookup Job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
query Parameters
businessPartnerId
Array of strings

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Number of results that should be fetched.

Example: limit=100
startAfter
string

Only records with an ID greater than this ID will be fetched.

Example: startAfter=5712566172571652
Responses
200

OK

401

Unauthorized

404

Not Found

get/v2/screeningjobs/{id}/results
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "limit": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}

Start Batch Screening Job

Start a job to screen business partners within a provided storage. The business partners are matched against sanction lists and for every business partner a detailed result is provided. Before you can run a screening job, you need to first upload business partners to a storage.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

chunkSize
integer <int32> [ 1 .. 10000 ]
Default: 100

Chunk size that should be used during reading from storage.

Example: "100"
configurationId
string (ComplianceListsScreeningConfigurationId)

ID of the configuration that should be used during screening. If not provided screening will try to use configuration attached to the API Key. In this case if no configuration is attached to the API Key, exception will be thrown.

Example: "64cd0303e1cd5s1e4354a1c6"
dataSourceIds
Array of strings non-empty

List of data source IDs that should be used to filter storage.

Example: ["64379b92ca99c81afa6a67e4"]
featuresOff
Array of strings (BatchScreeningJobFeature)

List of features to be disabled.

Items Enum: Description
ACTIVATE_STOP_WORDS

Activate detection of stop words and special calculation for matching score.

ACTIVATE_PROCESSING_LOG

Switches to store screening results into processing log.

Example: ["ACTIVATE_STOP_WORDS"]
featuresOn
Array of strings (BatchScreeningJobFeature)

List of features to be enabled.

Items Enum: Description
ACTIVATE_STOP_WORDS

Activate detection of stop words and special calculation for matching score.

ACTIVATE_PROCESSING_LOG

Switches to store screening results into processing log.

Example: ["ACTIVATE_STOP_WORDS"]
storageId
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
withStopWords
boolean
Default: false

Specifies if stop words are supposed to be detected and special calculation is supposed to be used for matching score.

Example: "false"
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

post/v2/screeningjobs
Request samples
application/json
{
  • "storageId": "<STORAGE_ID>"
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "createdAt": "2024-06-20T07:02:22Z",
  • "user": "johndoe",
  • "progress": "77",
  • "auditTrail": {
    }
}