Skip to main content
POST
/
api
/
customer
/
{customerId}
/
screen
/
{screeningId}
/
retry
retryScreening
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}/retry \
  --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
}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

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

Path Parameters

customerId
integer<int64>
required

customerId

screeningId
integer<int64>
required

screeningId

Query Parameters

engines
enum<string>[]
required

engines

Available options:
ARTEMISCAN,
DJ,
FACE_COMPARE,
INTERNET_SEARCH,
OCR,
OWN_RESTRICTED_LIST,
TR

Response

OK

additionalInformation
ScreeningAdditionalInformation · object
createdAt
Timestamp · object
createdBy
UserInfo · object
facInformation
ScreeningFACInformation · object
finalStatus
enum<string>
Available options:
DONE,
FAILED,
NEVER,
PENDING
hasHit
boolean
id
integer<int64>
isPeriodic
boolean
ocrInformation
ScreeningOCRInformation · object
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
updatedAt
Timestamp · object
updatedBy
UserInfo · object
valid
boolean