Get a screening
curl --request GET \
--url https://lens-api.tic.io/screening/{screeningId} \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/screening/{screeningId}"
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}', 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}",
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}"
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}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/screening/{screeningId}")
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",
"type": "<string>",
"companyId": 123,
"personId": 123,
"screenedAtUtc": "2023-11-07T05:31:56Z",
"testMode": true,
"reused": true,
"order": {
"documentOrderGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderedAtUtc": "2023-11-07T05:31:56Z",
"price": 123,
"currency": "<string>"
},
"summary": {
"subjectCount": 123,
"screenedSubjectCount": 123,
"notScreenedCount": 123,
"queryCount": 123,
"subjectsWithHits": 123,
"hitCount": 123,
"newHitCount": 123,
"pendingHitCount": 123,
"hitCountByCategory": {}
},
"beneficialOwnerStatus": "<string>",
"beneficialOwnerStatusDescription": "<string>",
"subjects": [
{
"subjectId": 123,
"type": "person",
"personId": 123,
"companyId": 123,
"reference": "<string>",
"name": "<string>",
"identityNumber": "<string>",
"birthDate": "<string>",
"citizenshipCountryCode": "<string>",
"screenedOn": "<string>",
"notScreenedReason": "protectedIdentity",
"roles": [
{
"group": "target",
"code": "<string>",
"description": "<string>",
"extentCode": "<string>",
"extentDescription": "<string>",
"positionStart": "2023-11-07T05:31:56Z"
}
],
"queryCount": 123,
"queries": [
{
"reason": "primary",
"name": "<string>",
"itemNumber": "<string>",
"itemDate": "<string>",
"rawHitCount": 123
}
],
"hitCount": 123,
"newHitCount": 123,
"maxHitRating": 123,
"hits": [
{
"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"
}
]
}
],
"warnings": [
"<string>"
],
"errors": [
"<string>"
]
}Screening
Get a screening
Returns a stored screening (company, person or search) in the same compact form as when it ran, with the current decisions on its hits. onlyWithHits=true leaves out subjects without hits, includeQueries=true adds the queries sent.
GET
/
screening
/
{screeningId}
Get a screening
curl --request GET \
--url https://lens-api.tic.io/screening/{screeningId} \
--header 'x-api-key: <api-key>'import requests
url = "https://lens-api.tic.io/screening/{screeningId}"
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}', 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}",
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}"
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}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://lens-api.tic.io/screening/{screeningId}")
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",
"type": "<string>",
"companyId": 123,
"personId": 123,
"screenedAtUtc": "2023-11-07T05:31:56Z",
"testMode": true,
"reused": true,
"order": {
"documentOrderGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderedAtUtc": "2023-11-07T05:31:56Z",
"price": 123,
"currency": "<string>"
},
"summary": {
"subjectCount": 123,
"screenedSubjectCount": 123,
"notScreenedCount": 123,
"queryCount": 123,
"subjectsWithHits": 123,
"hitCount": 123,
"newHitCount": 123,
"pendingHitCount": 123,
"hitCountByCategory": {}
},
"beneficialOwnerStatus": "<string>",
"beneficialOwnerStatusDescription": "<string>",
"subjects": [
{
"subjectId": 123,
"type": "person",
"personId": 123,
"companyId": 123,
"reference": "<string>",
"name": "<string>",
"identityNumber": "<string>",
"birthDate": "<string>",
"citizenshipCountryCode": "<string>",
"screenedOn": "<string>",
"notScreenedReason": "protectedIdentity",
"roles": [
{
"group": "target",
"code": "<string>",
"description": "<string>",
"extentCode": "<string>",
"extentDescription": "<string>",
"positionStart": "2023-11-07T05:31:56Z"
}
],
"queryCount": 123,
"queries": [
{
"reason": "primary",
"name": "<string>",
"itemNumber": "<string>",
"itemDate": "<string>",
"rawHitCount": 123
}
],
"hitCount": 123,
"newHitCount": 123,
"maxHitRating": 123,
"hits": [
{
"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"
}
]
}
],
"warnings": [
"<string>"
],
"errors": [
"<string>"
]
}Pro+ tier
Returns a stored screening, of a company, a person or a search, in the same compact form as when it ran, with the current decisions on its hits. Requires the
pep scope on the API key.
The response is described in Company and person screening.Authorizations
Path Parameters
The screening's id
Response
The stored screening
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes