Trigger Quick Scan Screening - Cynopsis API Documentation

triggerQuickScan

curl --request POST \
  --url https://api.artemis.cynopsis.co/api/quickscan/screen \
  --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
  },
  "hasHit": true,
  "id": 123,
  "isPeriodic": true,
  "ocrInformation": {
    "ocrDocumentId": 123
  },
  "profileId": 123,
  "quickscanName": "<string>",
  "remarks": [
    "<string>"
  ],
  "screenedWith": [],
  "screeningConclusion": [],
  "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
}

POST

api

quickscan

screen

triggerQuickScan

curl --request POST \
  --url https://api.artemis.cynopsis.co/api/quickscan/screen \
  --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
  },
  "hasHit": true,
  "id": 123,
  "isPeriodic": true,
  "ocrInformation": {
    "ocrDocumentId": 123
  },
  "profileId": 123,
  "quickscanName": "<string>",
  "remarks": [
    "<string>"
  ],
  "screenedWith": [],
  "screeningConclusion": [],
  "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 triggers a Quick Scan screening for an individual or a corporate entity. The scan runs asynchronously — the response returns immediately with a screeningId that you can use to poll for results.

Query Parameters

Parameter	Type	Required	Description
`name`	`string`	Yes	The name of the individual or corporate entity to screen.
`customerType`	`string`	Yes	Type of customer. Possible values: `INDIVIDUAL`, `CORPORATE`.
`chosenEngines`	`string[]`	Yes	One or more screening engines to include (repeat the parameter to add more).

Available Screening Engines

Value	Description
`ARTEMISCAN`	Cynopsis proprietary screening engine
`DJ`	Dow Jones
`TR`	World-Check (Refinitiv / LSEG)
`INTERNET_SEARCH`	Internet-based adverse media search
`OWN_RESTRICTED_LIST`	Your organisation’s custom restricted list

Headers

Header	Type	Required	Description
`Authorization`	`string`	Yes	Bearer token obtained from the authentication endpoint.
`X-Domain-ID`	`integer`	Yes	The domain identifier for your organisation.

Example Requests

Screen an Individual with ArtemiScan

curl -X POST "{{backend_url}}/api/quickscan/screen?name=John%20Doe&customerType=INDIVIDUAL&chosenEngines=ARTEMISCAN" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

Screen a Corporate Entity with Multiple Engines

curl -X POST "{{backend_url}}/api/quickscan/screen?name=Acme%20Corp&customerType=CORPORATE&chosenEngines=ARTEMISCAN&chosenEngines=DJ&chosenEngines=INTERNET_SEARCH" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

Response

A successful response returns a ScreeningResponseDto with an HTTP 200 status code.

Key Response Fields

Field	Type	Description
`id`	`integer`	The unique screening ID. Use this as `screeningId` in subsequent API calls.
`quickscanName`	`string`	The name that was screened.
`quickscanType`	`string`	`INDIVIDUAL` or `CORPORATE`.
`finalStatus`	`string`	Current status: `PENDING`, `DONE`, `FAILED`, or `NEVER`.
`screenedWith`	`string[]`	List of engines used in this screening.
`screeningConclusion`	`string[]`	Conclusions after screening completes — e.g., `PEP`, `SANCTION`, `ADVERSE_MEDIA`, `OWN_RESTRICTED_LIST`, `NO_HIT`.
`hasHit`	`boolean`	Whether any potential hits were found.
`potentialHits`	`object`	Map of engine name to hit count — e.g., `{ "ARTEMISCAN": 3, "DJ": 1 }`.
`status`	`object`	Detailed per-engine status — see below.
`createdAt`	`string`	Timestamp when the screening was created.

Status Object

The status field contains a map of each screening engine to its individual status:

{
  "status": {
    "ARTEMISCAN": "DONE",
    "DJ": "PENDING",
    "INTERNET_SEARCH": "DONE"
  }
}

Possible values per engine: PENDING, DONE, FAILED.

Example Response

{
  "id": 12345,
  "quickscanName": "John Doe",
  "quickscanType": "INDIVIDUAL",
  "finalStatus": "PENDING",
  "hasHit": false,
  "screenedWith": ["ARTEMISCAN", "DJ"],
  "screeningConclusion": [],
  "potentialHits": {},
  "status": {
    "id": 67890,
    "screeningId": 12345,
    "status": {
      "ARTEMISCAN": "PENDING",
      "DJ": "PENDING"
    }
  },
  "valid": true,
  "oddStatus": "OPEN",
  "remarks": [],
  "createdAt": "2025-01-15T10:30:00.000+00:00",
  "updatedAt": "2025-01-15T10:30:00.000+00:00"
}

What to Do Next

Poll for completion — Call GET /api/quickscan/screen/{screeningId} using the returned id until finalStatus becomes DONE.
Retrieve hits — Call GET /api/quickscan/screen/{screeningId}/hit?screeningType=ARTEMISCAN to get potential matches for each engine.

Notes

This is an ad-hoc scan and does not require a customer record to be created.
Multiple screening engines can be combined by repeating the chosenEngines query parameter.
The screening runs asynchronously. The initial response will have finalStatus: "PENDING".
Use Get Quick Scan List to retrieve historical Quick Scans and review past results.

Important Notice

The Try-it SEND button in the documentation UI may not serialize query parameters correctly for this endpoint. Always copy the generated cURL command and run it in your terminal or API client (e.g., Postman, Insomnia).

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

chosenEngines

enum<string>[]

required

One or more screening engines (repeat param to add more).

Available options:

ARTEMISCAN,

DJ,

FACE_COMPARE,

INTERNET_SEARCH,

OCR,

OWN_RESTRICTED_LIST,

TR

customerType

enum<string>

required

customerType

Available options:

CORPORATE,

INDIVIDUAL

name

string

required

name

Response

additionalInformation

ScreeningAdditionalInformation · object

Show child attributes

createdAt

Timestamp · object

Show child attributes

createdBy

UserInfo · object

Show child attributes

facInformation

ScreeningFACInformation · object

Show child attributes

finalStatus

enum<string>

Available options:

DONE,

FAILED,

NEVER,

PENDING

hasHit

boolean

integer<int64>

isPeriodic

boolean

ocrInformation

ScreeningOCRInformation · object

Show child attributes

oddStatus

enum<string>

Available options:

CLOSED,

OPEN

profileId

integer<int64>

quickscanName

string

quickscanType

enum<string>

Available options:

CORPORATE,

INDIVIDUAL

remarks

string[]

screenedWith

enum<string>[]

Available options:

ARTEMISCAN,

DJ,

FACE_COMPARE,

INTERNET_SEARCH,

OCR,

OWN_RESTRICTED_LIST,

TR

screeningConclusion

enum<string>[]

Available options:

ADVERSE_MEDIA,

NO_HIT,

OWN_RESTRICTED_LIST,

PEP,

SANCTION

status

ScreeningStatusResponseDto · object

Show child attributes

updatedAt

Timestamp · object

Show child attributes

updatedBy

UserInfo · object

Show child attributes

valid

boolean

Get Quick Scan List

Get Quick Scan Screening

Documentation Index

​Query Parameters

​Available Screening Engines

​Headers

​Example Requests

​Screen an Individual with ArtemiScan

​Screen a Corporate Entity with Multiple Engines

​Response

​Key Response Fields

​Status Object

​Example Response

​What to Do Next

​Notes

​Important Notice

Authorizations

Headers

Query Parameters

Response

Query Parameters

Available Screening Engines

Headers

Example Requests

Screen an Individual with ArtemiScan

Screen a Corporate Entity with Multiple Engines

Response

Key Response Fields

Status Object

Example Response

What to Do Next

Notes

Important Notice