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

required

string

ID of the Batch Screening Job.

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

Responses

200

401

Unauthorized

404

Not Found

get/v2/screeningjobs/{id}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2024-07-26T11:07:59Z",
"user": "johndoe",
"progress": "77",
"auditTrail": {"performedBy": "John Doe",
"screenedNames": [{"value": "Corporate Data Quality AG"
}
],
"screeningDate": "2024-07-26T11:07:59Z",
"screeningSettings": {"listsUsedForCheck": [{"authority": "The Federal Financial Supervisory Authority (BaFin)",
"name": "Notices and Measures",
"type": "WATCHLIST",
"technicalKey": "INFO4C_WL_287"
}
],
"minMatchingScore": "0.8"
}
}
}

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

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

401

Unauthorized

404

Not Found

get/v2/screeningjobs/{id}/results

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"limit": "5712566172571652",
"total": "67",
"values": [{"jobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
"status": "RUNNING",
"businessPartnerId": "63e635235c06b7396330fe40",
"request": {"entry": {"names": [{"value": "Corporate Data Quality AG"
}
],
"addresses": [{"country": {"shortName": null
},
"localities": [null
],
"thoroughfares": [null
],
"postCodes": [null
]
}
]
},
"dataSources": [{"technicalKey": "SANCTION_LIST"
}
],
"configuration": {"matchingThreshold": "0.8",
"lists": [{"technicalKey": "INFO4C_PEP_25"
},
{"technicalKey": "INFO4C_PEP_7"
}
]
},
"configurationId": "64cd0303e1cd5s1e4354a1c6",
"featuresOn": ["ACTIVATE_STOP_WORDS",
"SHOW_AUDIT_TRAIL"
],
"featuresOff": ["ACTIVATE_STOP_WORDS",
"SHOW_AUDIT_TRAIL"
],
"limit": "10",
"startAfter": "5712566172571652"
},
"result": {"total": "67",
"nextStartAfter": "5712566172571652",
"startAfter": "5712566172571652",
"values": [{"cdqId": "SANCTIONLIST:10120020770",
"entry": {"externalId": "The ID managed in the customer's SAP systems.",
"names": [null
],
"addresses": [null
],
"list": {"technicalKey": null,
"name": null,
"issuingBody": null
},
"additionalInformation": [null
]
},
"matchingProfile": {"matchingScores": {"overall": null
}
},
"dataSource": {"url": "https://meta.cdq.com/Data_source/BR.RF",
"name": "Receita Federal Brazil",
"technicalKey": "BR_RF"
}
}
],
"auditTrail": {"performedBy": "John Doe",
"screenedNames": [{"value": "Corporate Data Quality AG"
}
],
"screeningDate": "2024-07-26T11:07:59Z",
"screeningSettings": {"listsUsedForCheck": [{"authority": null,
"name": null,
"type": null,
"technicalKey": null
}
],
"minMatchingScore": "0.8"
}
}
}
}
]
}

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

400

Bad Request

401

Unauthorized

404

Not Found

post/v2/screeningjobs

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"storageId": "<STORAGE_ID>"
}

Response samples

application/json

{"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"status": "RUNNING",
"createdAt": "2024-07-26T11:07:59Z",
"user": "johndoe",
"progress": "77",
"auditTrail": {"performedBy": "John Doe",
"screenedNames": [{"value": "Corporate Data Quality AG"
}
],
"screeningDate": "2024-07-26T11:07:59Z",
"screeningSettings": {"listsUsedForCheck": [{"authority": "The Federal Financial Supervisory Authority (BaFin)",
"name": "Notices and Measures",
"type": "WATCHLIST",
"technicalKey": "INFO4C_WL_287"
}
],
"minMatchingScore": "0.8"
}
}
}

Batch Screening

Get Batch Screening Job

path Parameters

List Screening Results

path Parameters

query Parameters

Start Batch Screening Job

Request Body schema: application/jsonrequired

Request Body schema: application/json
required