Skip to main content
GET
/
api
/
quickscan
/
screen
/
{screeningId}
getQuickScan
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "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
}
This endpoint retrieves the details of a specific Quick Scan screening using its unique screeningId.

Path Parameters

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

Description

  • Use this endpoint to check the results of a previously triggered Quick Scan.
  • Typical details may include:
    • id — Screening identifier.
    • quickscanName — The searched name (individual or corporate).
    • quickscanType — Type of scan performed.
    • chosenEngines — Engines used in the scan.
    • potentialHits — Number of potential matches.
    • createdAt — When the screening was triggered.
    • status — Current state of the screening (e.g., PENDING, DONE).

Notes

  • Retrieve screeningId from the Quick Scan List.
  • Use this API to poll results if the screening may take time to complete.

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

Response

OK

additionalInformation
object
createdAt
object
createdBy
object
facInformation
object
finalStatus
enum<string>
Available options:
DONE,
FAILED,
NEVER,
PENDING
hasHit
boolean
id
integer
isPeriodic
boolean
ocrInformation
object
oddStatus
enum<string>
Available options:
CLOSED,
OPEN
profileId
integer
quickscanName
string
quickscanType
enum<string>
Available options:
CORPORATE,
INDIVIDUAL
remarks
string[]
screenedWith
enum<string>[]
screeningConclusion
enum<string>[]
status
object
updatedAt
object
updatedBy
object
valid
boolean