Skip to main content
GET
getQuickScan
The Quick Scan List endpoint retrieves a history of Quick Scans performed within the domain.

Description

  • Displays all previously executed Quick Scans, including metadata such as:
    • id — Unique identifier of the Quick Scan.
    • quickscanName — The searched individual or corporate name.
    • quickscanType — Type of scan performed: INDIVIDUAL or CORPORATE.
    • screenedWith — The screening engine(s) used for the scan (e.g., ARTEMISCAN , INTERNET_SEARCH , OWN_RESTRICTED_LIST).
    • potentialHits — Number of potential matches identified by the specified screening engine(s).

Notes

  • Use this API to review past Quick Scan activities.
  • Results may include both active and archived scans.

Authorizations

Authorization
string
header
required

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

FlowClient Credentials
Token URL
https://crm.cynopsis.co/oauth/token

Headers

X-Domain-ID
integer<int64>
required

X-Domain-ID

Query Parameters

offset
integer<int64>
paged
boolean
pageNumber
integer<int32>
pageSize
integer<int32>
searchString
string

searchString

sort.sorted
boolean
sort.unsorted
boolean
unpaged
boolean

Response

OK

content
ScreeningResponseDto · object[]
empty
boolean
first
boolean
last
boolean
number
integer<int32>
numberOfElements
integer<int32>
pageable
Pageable · object
size
integer<int32>
sort
Sort · object
totalElements
integer<int64>
totalPages
integer<int32>