Record a decision on a screening hit
curl --request PUT \
--url https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"comment": "<string>"
}
'import requests
url = "https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution"
payload = { "comment": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({comment: '<string>'})
};
fetch('https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution', 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}/resolution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'comment' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution"
payload := strings.NewReader("{\n \"comment\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"comment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"comment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}Screening
Record a decision on a screening hit
Marks a hit as truePositive (the subject is on the list), falsePositive (a different person or organisation), escalated or noMatch, with an optional comment for the audit trail; pending undoes the decision. The decision is carried into later screenings of the same person or company, whichever company screening they appear in, until the supplier updates the list entry.
PUT
/
screening
/
{screeningId}
/
hits
/
{hitId}
/
resolution
Record a decision on a screening hit
curl --request PUT \
--url https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"comment": "<string>"
}
'import requests
url = "https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution"
payload = { "comment": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
body: JSON.stringify({comment: '<string>'})
};
fetch('https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution', 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}/resolution",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'comment' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json-patch+json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution"
payload := strings.NewReader("{\n \"comment\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"comment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/screening/{screeningId}/hits/{hitId}/resolution")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"comment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}Pro+ tier
Records the team’s decision on a hit:
truePositive, falsePositive, escalated or noMatch, or pending to undo it. Requires the pep scope on the API key.
The decision follows the person or company into later screenings until the list updates the entry. See Reviewing hits.Authorizations
Path Parameters
The screening's id
The hit's id
Body
application/json-patch+jsonapplication/jsontext/jsonapplication/*+json
Response
The hit with its decision
Available options:
other, pep, sanction, adverseMedia, regulatoryWarning Available options:
primary, otherIdentityNumber, otherFamilyName, previousName, givenNameVariant, alternativeBirthDate, otherCompanyName, supplied Available options:
pending, truePositive, falsePositive, escalated, noMatch