Skip to main content

Screening – Added

A new endpoint returns the document state of every match in a batch in one call. For each match that has at least one document, it returns the number of documents provided, still in progress, failed and virus-detected, so a client can check the documents on every hit without requesting each match individually. Matches with no documents are not returned, and only match documents are counted (entity documents are not). The optional onlyBlocking query parameter (default false) limits the response to matches that have a document still in progress, failed or virus-detected, which keeps it small for very large batches. The endpoint is available to tenants where the feature is enabled and returns 403 otherwise.

The existing endpoint that returns the document state of every entity in a batch now also reports the number of failed and virus-detected documents for each entity.

A document counts as failed when its upload or processing did not complete, as virus-detected when the virus scan found malware in it, and as in progress while it is still being uploaded or scanned.

Affected Endpoints​

New​

  • GET /screeningquery/api/v4/batch/{batchId}/match/documents (new: returns entityId, matchId, providedDocumentsCount, inProgressDocumentsCount, failedDocumentsCount and virusDetectedDocumentsCount for every match in the batch that has documents; with onlyBlocking=true, only the matches that have an in-progress, failed or virus-detected document)

Updated​

  • GET /screeningquery/api/v4/batch/{batchId}/entity/documents (updated: response now includes failedDocumentsCount and virusDetectedDocumentsCount for every entity)