getAScreeningHit

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

getAScreeningHit

cURL

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

import requests

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

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/customer/{customerId}/screen/{screeningId}/hit/{screeningHitId}', 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/customer/{customerId}/screen/{screeningId}/hit/{screeningHitId}",
  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/customer/{customerId}/screen/{screeningId}/hit/{screeningHitId}"

	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/customer/{customerId}/screen/{screeningId}/hit/{screeningHitId}")
  .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/customer/{customerId}/screen/{screeningId}/hit/{screeningHitId}")

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

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

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

screeningHitId · integer<int64> · required

screeningHitId

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

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