Screening
List a subject's hits
The hits of one person or company in a screening, strongest first, a page at a time (AG Grid request model: startRow, endRow). onlyNew, onlyPending, category, minRating and hitRating narrow them. The full list entry of a hit: GET /screening/{screeningId}/hits/{hitId}.
Returns the hits of one person or company in a screening, strongest first, a page at a time. Use it for screenings with many hits: fetch the screening with includeHits=false to get each subject’s hit counts, then page the hits of the subjects you review. Requires the pep scope on the API key.
The body is the AG Grid request model: startRow and endRow (at most 500 rows per page). The response is { "success": true, "rows": [...], "lastrow": -1 }, where lastrow is -1 while more rows follow. Each row has the same properties as a hit.
onlyNew=true returns only hits the team had not seen before, onlyPending=true only hits without a decision, category only one kind of list (sanction, pep, regulatoryWarning or other), and minRating only hits rated at least that. The full list entry of a hit is fetched with Get a screening hit.
Authorization
x-api-keystringheaderrequiredYour API key, sent in the x-api-key header.
Path parameters
screeningIdstringrequiredThe screening's id
subjectIdintegerrequiredThe subject's id (subjectId in the screening)
Query parameters
onlyNewbooleanOnly hits the team had not seen before
onlyPendingbooleanOnly hits without a decision
categorystringOnly hits of this category: pep, sanction, regulatoryWarning or other
minRatingintegerOnly hits rated at least this (5 identity number, 4 name and birth date, 2 name and country, 1 name only)
hitRatingintegerOnly hits with exactly this rating
Bodyapplication/json
startRowintegerendRowintegerrowGroupColsRowGroupModel[] | nullHide child attributes
idstring | nulldisplayNamestring | nullfieldstring | nullgroupKeysstring[] | nullfilterModelFilterModel[] | nullHide child attributes
columnNamestring | nullcolumnNameWithAliasstring | nullread-onlyfilterTypestring | nullsortModelSortModel[] | nullHide child attributes
sortstringcolIdstring | nullResponses
AG Grid page of TeamScreeningHitSummary_Dto rows
Screening or subject not found
Try it with a grid
A server-side data grid bound to this endpoint through the proxy. Sort and filter columns and watch the request body the grid sends; the response arrives as rows with lastrow.
Stored in this browser only (until you forget it) and sent as the x-api-key header through the documentation proxy.
Enter your API key to load the grid.
{ "startRow": 0, "endRow": 50, "sortModel": [], "filterModel": {} } Sort or filter a column and the request body updates; the response arrives as rows and lastrow.