Skip to main content
GET
/
api
/
quickscan
getQuickScan
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/quickscan/ \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "content": [
    {
      "additionalInformation": {
        "djMonitoringCaseId": "<string>",
        "djMonitoringTxId": "<string>",
        "faceCompareDocumentId": "<string>",
        "faceCompareSelfieId": "<string>",
        "ocrDocumentId": "<string>"
      },
      "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>"
      },
      "facInformation": {
        "faceCompareDocumentId": 123,
        "faceCompareSelfieId": 123
      },
      "finalStatus": "DONE",
      "hasHit": true,
      "id": 123,
      "isPeriodic": true,
      "ocrInformation": {
        "ocrDocumentId": 123
      },
      "oddStatus": "CLOSED",
      "profileId": 123,
      "quickscanName": "<string>",
      "quickscanType": "CORPORATE",
      "remarks": [
        "<string>"
      ],
      "screenedWith": [
        "ARTEMISCAN"
      ],
      "screeningConclusion": [
        "ADVERSE_MEDIA"
      ],
      "status": {
        "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>"
        },
        "id": 123,
        "profileId": 123,
        "screeningId": 123,
        "status": {},
        "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>"
        }
      },
      "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>"
      },
      "valid": true
    }
  ],
  "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
}
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.

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>