Get Quick Scan Screening Hits

GET /api/quickscan/screen/{screeningId}/hit

getQuickScanHit

cURL

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

import requests

url = "https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit"

headers = {
    "X-Domain-ID": "<x-domain-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Domain-ID': '<x-domain-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Domain-ID: <x-domain-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Domain-ID", "<x-domain-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit")
  .header("X-Domain-ID", "<x-domain-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/quickscan/screen/{screeningId}/hit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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 paginated potential hits for a specific Quick Scan screening, filtered by screening type (engine).

---

Path Parameters

Parameter	Type	Required	Description
screeningId	integer	Yes	The unique identifier of the Quick Scan screening (returned from Trigger Quick Scan).

---

Query Parameters

Parameter	Type	Required	Description
screeningType	string	Yes	The screening engine whose hits you want to retrieve.
pageNumber	integer	No	Page number (0-indexed). Default: 0.
pageSize	integer	No	Number of results per page. Default: 20.

Available Screening Types

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

Get ArtemiScan Hits

curl -X GET "{{backend_url}}/api/quickscan/screen/12345/hit?screeningType=ARTEMISCAN" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

Get Dow Jones Hits (with Pagination)

curl -X GET "{{backend_url}}/api/quickscan/screen/12345/hit?screeningType=DJ&pageNumber=0&pageSize=10" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

Get Internet Search Hits

curl -X GET "{{backend_url}}/api/quickscan/screen/12345/hit?screeningType=INTERNET_SEARCH" \
  -H "Authorization: Bearer <token>" \
  -H "X-Domain-ID: {{domain_id}}"

---

Response

A successful response returns a paginated Page<ScreeningHitResponseDto> with an HTTP 200 status code.

Pagination Wrapper

Field	Type	Description
content	array	Array of ScreeningHitResponseDto objects for the current page.
totalElements	integer	Total number of hits across all pages.
totalPages	integer	Total number of pages.
number	integer	Current page number (0-indexed).
size	integer	Page size.
first	boolean	Whether this is the first page.
last	boolean	Whether this is the last page.

Hit Object Fields (ScreeningHitResponseDto)

Field	Type	Description
id	integer	Unique hit identifier.
screeningId	integer	The parent screening ID.
screeningType	string	The engine that produced this hit (e.g., ARTEMISCAN, DJ).
externalId	string	External reference ID from the screening provider.
body	object	The full hit payload from the screening engine. Structure varies by engine — see Hit Body by Engine below.
diff	object	Differences highlighted between the screened name and the matched entity.
matched	string	Resolution status: TRUE_HIT, FALSE_POSITIVE, or NO_ACTION (default).
newMatch	boolean	Whether this is a newly identified match (appears for the first time).
commentCount	integer	Number of comments on this hit.
comment	array	List of comments attached to this hit.
filtered	boolean	Whether this hit was filtered by rules.
createdAt	string	Timestamp when the hit was identified.

Example Response

{
  "content": [
    {
      "id": 98765,
      "screeningId": 12345,
      "screeningType": "ARTEMISCAN",
      "externalId": "AC-2025-001",
      "body": {
        "name": "John Doe",
        "matchScore": 95,
        "categories": ["PEP", "SANCTION"],
        "country": "US",
        "dateOfBirth": "1970-01-01",
        "source": "OFAC SDN List"
      },
      "diff": {
        "name": {
          "original": "John Doe",
          "matched": "John M. Doe"
        }
      },
      "matched": "NO_ACTION",
      "newMatch": true,
      "commentCount": 0,
      "comment": [],
      "filtered": false,
      "createdAt": "2025-01-15T10:31:00.000+00:00",
      "updatedAt": "2025-01-15T10:31:00.000+00:00"
    }
  ],
  "totalElements": 3,
  "totalPages": 1,
  "number": 0,
  "size": 20,
  "first": true,
  "last": true
}

---

Hit Body by Engine

The body field contains engine-specific data. The structure differs depending on the screeningType:

ARTEMISCAN

Contains structured match data including name, match score, categories (PEP, SANCTION, ADVERSE_MEDIA), country, date of birth, and source references.

DJ (Dow Jones)

Contains Dow Jones profile data including name variants, associated countries, PEP status, sanction lists, and related entities.

TR (World-Check)

Contains Refinitiv World-Check profile data including name, category, sub-category, linked countries, and identification details.

INTERNET_SEARCH

Contains internet search results including article title, URL, snippet, publication date, and relevance score.

OWN_RESTRICTED_LIST

Contains matched entries from your organisation’s custom restricted list.

---

Notes

• You must first trigger a Quick Scan with Trigger Quick Scan Screening and obtain the screeningId.
• Ensure the screening for the requested screeningType has completed (DONE status) before fetching hits. You can check this with Get Quick Scan Screening.
• Each screeningType returns hits independently — call this endpoint once per engine you want to inspect.
• Hits default to matched: "NO_ACTION". Use the Artemis UI or additional APIs to mark hits as TRUE_HIT or FALSE_POSITIVE.

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

screeningId · integer<int64> · required

screeningId

Query Parameters

screeningType · enum<string> · required

screeningType

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

offset · integer<int64>

paged · boolean

pageNumber · integer<int32>

pageSize · integer<int32>

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>