Skip to main content
GET
/
api
/
quickscan
/
screen
/
{screeningId}
/
hit
getQuickScanHit
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "content": [
    {
      "body": {},
      "commentCount": 123,
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "diff": {},
      "externalId": "<string>",
      "id": 123,
      "matched": "FALSE_POSITIVE",
      "newMatch": true,
      "profileId": 123,
      "screeningId": 123,
      "screeningType": "ARTEMISCAN",
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}
This endpoint retrieves all potential hits generated by a specific Quick Scan screening.

​
Path Parameters

  • screeningId (required) — The unique identifier of the Quick Scan screening.

​
Description

  • Returns the list of all hits identified during the Quick Scan.

​
Notes

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Domain-ID
integer
required

X-Domain-ID

Path Parameters

​
screeningId
integer
required

screeningId

Query Parameters

​
screeningType
enum<string>
required

screeningType

Available options:
ARTEMISCAN,
DJ,
FACE_COMPARE,
INTERNET_SEARCH,
OCR,
OWN_RESTRICTED_LIST,
TR
​
offset
integer
​
paged
boolean
​
pageNumber
integer
​
pageSize
integer
​
sort.sorted
boolean
​
sort.unsorted
boolean
​
unpaged
boolean

Response

OK

​
content
ScreeningHitResponseDto · object[]
​
empty
boolean
​
first
boolean
​
last
boolean
​
number
integer
​
numberOfElements
integer
​
pageable
object
​
size
integer
​
sort
object
​
totalElements
integer
​
totalPages
integer