Step 5d — Get Hit Details from Latest Screening

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

getScreeningHits

cURL

curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/{customerId}/screen/{screeningId}/hit \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'

200

{
  "content": [
    {
      "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,
      "newMatch": true,
      "profileId": 123,
      "screeningId": 123,
      "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>"
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

This endpoint retrieves the full details of a specific screening hit for a Primary Customer from the latest screening results.

Use it when you need the granular record behind a match (e.g., a sanctions or PEP hit), including source lists, matched fields, scores, and references.

Path Parameters

• customerId — The respective Customer ID.

  • For a Primary Customer, retrieve from Step 3b — Get a Single Primary Customer.
  • For a CRP, retrieve from Step 3c — Get CRPs of a Customer.

• screeningId — The identifier of the latest screening run for the customer.
  Retrieve from Step 5b — Get Summary of Latest Screening.

• screeningType — The screening engine that produced the hit. Supported values:

  • DJ
  • ARTEMISCAN
  • TR
  • INTERNET_SEARCH
  • OWN_RESTRICTED_LIST

Example Request

curl -X GET "{{backend_url}}/api/customer/{{customerId}}/screen/{{latest_screening_id}}/hit?&screeningType={{screening_type}}" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

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

Query Parameters

offset · integer<int64>

paged · boolean

pageNumber · integer<int32>

pageSize · integer<int32>

screeningType · enum<string> · required

screeningType

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

sort.sorted · boolean

sort.unsorted · boolean

unpaged · boolean

Response

200

*/*

OK

content · ScreeningHitResponseDto · object[]

Show child attributes

empty · boolean

first · boolean

last · boolean

number · integer<int32>

numberOfElements · integer<int32>

pageable · Pageable · object

Show child attributes

size · integer<int32>

sort · Sort · object

Show child attributes

totalElements · integer<int64>

totalPages · integer<int32>