Step 5e — Conclude Screening Results

PUT /api/customer/{customerId}/screen/{screeningId}/hit

markParticularHitAsAMatch

cURL

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

200

[
  {
    "body": {},
    "commentCount": 123,
    "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>"
    },
    "diff": {},
    "externalId": "<string>",
    "id": 123,
    "matched": "FALSE_POSITIVE",
    "newMatch": true,
    "profileId": 123,
    "screeningId": 123,
    "screeningType": "ARTEMISCAN",
    "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>"
    }
  }
]

This step allows the compliance teams can classify each hit as either a true hit or a false hit.

Inputs

• screeningHitIds
  An array of one or more hit IDs that you want to conclude.
  These IDs are retrieved from Step 5d — Get Hit Details from Latest Screening.

• match
  The conclusion decision. Supported values:

  • TRUE_HIT
  • FALSE_POSITIVE
  • NO_ACTION

Example Request

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

Notes

• Use this step after you have retrieved hit IDs in Step 5d.
• Multiple screeningHitIds can be processed together.
• Once concluded, the hit will reflect its final status in the screening results.

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

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

requestDto

match · enum<string> · required

Available options: FALSE_POSITIVE, NO_ACTION, TRUE_HIT

screeningHitIds · integer<int64>[] · required

Response

200

*/*

OK

body · JsonNode · object

commentCount · integer<int64>

createdAt · Timestamp · object

Show child attributes

createdBy · UserInfo · object

Show child attributes

diff · JsonNode · object

externalId · string

id · integer<int64>

matched · enum<string>

Available options: FALSE_POSITIVE, NO_ACTION, TRUE_HIT

newMatch · boolean

profileId · integer<int64>

screeningId · integer<int64>

screeningType · enum<string>

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

updatedAt · Timestamp · object

Show child attributes

updatedBy · UserInfo · object

Show child attributes