Step 5f — Update Screening Conclusion - Cynopsis API Documentation

updateScreeningConclusion

curl --request PUT \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "conclusions": []
}
'

{
  "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
}

PUT

api

customer

{customerId}

screen

{screeningId}

updateScreeningConclusion

curl --request PUT \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "conclusions": []
}
'

{
  "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 step allows the user to update the overall conclusion of a customer’s latest screening. It is used when compliance teams want to change or finalize the decision for a given screening run after reviewing all hits and results.

Inputs

customerId The respective Primary Customer’s CustomerId.
screeningId
The identifier of the specific screening run that requires an updated conclusion.
- Retrieve from Step 5b — Get Summary of Latest Screening.
conclusions
The screening conclusion decision. Supported values:
- NO_HIT
- ADVERSE_MEDIA
- OWN_RESTRICTED_LIST
- PEP
- SANCTION

curl -X PUT "{{backend_url}}/api/customer/4424/screen/991" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}" \
  -H "Content-Type: application/json" \
  -d '{
    "conclusions": ["NO_HIT"]
  }'

Notes

This step is performed after hits have been concluded in Step 5e — Conclude Screening Results.
It allows the compliance officer to finalize the overall outcome of the screening, ensuring the system reflects the most accurate conclusion.
Updating a screening conclusion may override previous results, so it should be used carefully.

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

Body

application/json

conclusionRequestDto

conclusions

enum<string>[]

Available options:

ADVERSE_MEDIA,

NO_HIT,

OWN_RESTRICTED_LIST,

PEP,

SANCTION

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

Step 5e — Conclude Screening Results

Step 6 — Risk Assessment

Documentation Index

​Inputs

​Notes

Authorizations

Headers

Path Parameters

Body

Response

Inputs

Notes