Batch Screening

Manage batch screening processes for Business Partners. It encompasses endpoints for initiating screening jobs, monitoring their progress, and retrieving the results.

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

403

Forbidden

404

Not Found

get/screeningjobs/{id}/results
Request samples 
Response samples 
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "limit": "5712566172571652",
  • "total": "67",
  • "values": [
    ]
}
Poll 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 Lookup Job.


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


401
Unauthorized


403
Forbidden


404
Not Found


get/screeningjobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "createdAt": "2024-09-18T14:16:36Z",
  • "user": "johndoe",
  • "progress": "77"
}
Start 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


dataSourceIds
Array of strings (BusinessPartnerStorageDataSourceId) 
Optional list of data source ids to filter the business partners storage


 
 Example:  ["648824a691d8d2503d65103e"]
optionChunkSize
integer <int32>   [ 1 .. 10000 ] 
 Default:  100
Chunk size that should be used during reading from storage.


 
 Example:  "100"
optionDataMatchingDefinitionId
string
Optional data matching definition ID to be used during matching with sanction lists


 
 Example:  "6461e6113b1865304b3038b6"
storageId
string (BusinessPartnerStorageId) 
Unique identifier of the Storage.


 
 Example:  "72d6900fce6b326088f5d9d91049e3e6"
Responses 
200
OK


201
Created


400
The sent request is malformed.


401
Unauthorized


403
Forbidden


404
Not Found


post/screeningjobs
Request samples 
application/json
{
  • "storageId": "<STORAGE_ID>"
}
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "createdAt": "2024-09-18T14:16:36Z",
  • "user": "johndoe",
  • "progress": "77"
}