Skip to main content

Screening – Updated

Entity responses now include a matchSummary: a per-provider breakdown of the entity's matches by resolution status (unresolved, match, no match). Clients can render batch-level summaries from a single entity list call instead of fetching every entity's matches individually. Counts are per provider, so a client that needs an entity-level total sums across the providers it cares about.

A new endpoint returns the document state of every entity in a batch in one call: for each entity, the number of documents provided and the number still in progress. Entities with no documents are included with zero counts, and only entity documents are counted (match documents are not).

Affected Endpoints​

New​

  • GET /screeningquery/api/v4/batch/{batchId}/entity/documents (new: returns entityId, providedDocumentsCount and inProgressDocumentsCount for every entity in the batch)

Updated​

  • GET /screeningquery/api/v4/batch/{batchId}/entity (updated: response now includes matchSummary)
  • GET /screeningquery/api/v4/batch/{batchId}/entity/{entityId} (updated: response now includes matchSummary)