Get a screening hit
curl --request GET \
--url https://lens-api.tic.io/screening/{screeningId}/hits/{hitId} \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}', 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://lens-api.tic.io/screening/{screeningId}/hits/{hitId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://lens-api.tic.io/screening/{screeningId}/hits/{hitId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"screeningId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectId": 123,
"hit": {
"hitId": 123,
"category": "other",
"name": "<string>",
"birthDate": "<string>",
"isEntity": true,
"sourceName": "<string>",
"listType": "<string>",
"externalId": "<string>",
"hitRating": 123,
"nameMatchScore": 123,
"tier": 123,
"matchedVia": "primary",
"isNew": true,
"resolution": "pending",
"resolvedAtUtc": "2023-11-07T05:31:56Z",
"resolutionComment": "<string>",
"listEntryUpdatedAtUtc": "2023-11-07T05:31:56Z"
},
"matchedQuery": {
"reason": "primary",
"name": "<string>",
"itemNumber": "<string>",
"itemDate": "<string>",
"rawHitCount": 123
},
"detailsAvailable": true,
"entry": {
"type": "<string>",
"hitId": 123,
"isNew": true,
"resolution": "pending",
"name": "<string>",
"identityNumber": "<string>",
"birthDate": "<string>",
"hitRating": 123,
"hitRatingDescription": "<string>",
"nameMatchScore": 123,
"listType": "<string>",
"listItemDataType": "<string>",
"sourceName": "<string>",
"externalId": "<string>",
"lastUpdatedUtc": "2023-11-07T05:31:56Z",
"tier": 123,
"isProtectedIdentity": true,
"isMale": true,
"title": "<string>",
"comment": "<string>",
"legalForm": "<string>",
"operationalStatus": "<string>",
"countries": [
"<string>"
],
"citizenships": [
"<string>"
],
"aliases": [
"<string>"
],
"externalUrls": [
"<string>"
],
"roles": [
{
"roleType": "<string>",
"roleTypeDescription": "<string>",
"title": "<string>",
"organization": "<string>",
"countryCode": "<string>",
"from": "<string>",
"to": "<string>",
"comment": "<string>"
}
],
"engagements": [
{
"engagementType": "<string>",
"name": "<string>",
"corporateId": "<string>",
"ownershipStake": 123,
"from": "<string>",
"to": "<string>"
}
],
"relationships": [
{
"name": "<string>",
"relationshipType": "<string>",
"title": "<string>",
"comment": "<string>"
}
]
}
}Screening
Get a screening hit
Returns one hit with the full list entry from the supplier: aliases, roles, relationships, countries, identity numbers and sources, and the query that found it. The full entry is shown for 24 hours after the screening, as long as the screening is reused; after that detailsAvailable is false and the hit summary and the decision are shown without it.
GET
/
screening
/
{screeningId}
/
hits
/
{hitId}
Get a screening hit
curl --request GET \
--url https://lens-api.tic.io/screening/{screeningId}/hits/{hitId} \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}', 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://lens-api.tic.io/screening/{screeningId}/hits/{hitId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://lens-api.tic.io/screening/{screeningId}/hits/{hitId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"screeningId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subjectId": 123,
"hit": {
"hitId": 123,
"category": "other",
"name": "<string>",
"birthDate": "<string>",
"isEntity": true,
"sourceName": "<string>",
"listType": "<string>",
"externalId": "<string>",
"hitRating": 123,
"nameMatchScore": 123,
"tier": 123,
"matchedVia": "primary",
"isNew": true,
"resolution": "pending",
"resolvedAtUtc": "2023-11-07T05:31:56Z",
"resolutionComment": "<string>",
"listEntryUpdatedAtUtc": "2023-11-07T05:31:56Z"
},
"matchedQuery": {
"reason": "primary",
"name": "<string>",
"itemNumber": "<string>",
"itemDate": "<string>",
"rawHitCount": 123
},
"detailsAvailable": true,
"entry": {
"type": "<string>",
"hitId": 123,
"isNew": true,
"resolution": "pending",
"name": "<string>",
"identityNumber": "<string>",
"birthDate": "<string>",
"hitRating": 123,
"hitRatingDescription": "<string>",
"nameMatchScore": 123,
"listType": "<string>",
"listItemDataType": "<string>",
"sourceName": "<string>",
"externalId": "<string>",
"lastUpdatedUtc": "2023-11-07T05:31:56Z",
"tier": 123,
"isProtectedIdentity": true,
"isMale": true,
"title": "<string>",
"comment": "<string>",
"legalForm": "<string>",
"operationalStatus": "<string>",
"countries": [
"<string>"
],
"citizenships": [
"<string>"
],
"aliases": [
"<string>"
],
"externalUrls": [
"<string>"
],
"roles": [
{
"roleType": "<string>",
"roleTypeDescription": "<string>",
"title": "<string>",
"organization": "<string>",
"countryCode": "<string>",
"from": "<string>",
"to": "<string>",
"comment": "<string>"
}
],
"engagements": [
{
"engagementType": "<string>",
"name": "<string>",
"corporateId": "<string>",
"ownershipStake": 123,
"from": "<string>",
"to": "<string>"
}
],
"relationships": [
{
"name": "<string>",
"relationshipType": "<string>",
"title": "<string>",
"comment": "<string>"
}
]
}
}Pro+ tier
Returns one hit with the full list entry: aliases, roles, relationships, countries, identity numbers and sources, plus the query that found it. Requires the
pep scope on the API key.
The entry has the same properties as a hit in search results. It is shown for 24 hours after the screening; after that detailsAvailable is false and only the summary and the decision are returned. See Reviewing hits.Authorizations
Path Parameters
The screening's id
The hit's id