Trulioo Watchlist Request
The Trulioo Watchlist service is integrated into Trulioo's Identity services. Customers using our KYC or KYB identity solutions do not need to make any changes to their request structure except to add the VerboseMode parameter.
Prerequisites
- Before you get started, make sure you have either a NAPI user account or a Trulioo account.
- You have existing knowledge of the Trulioo Platform API.
- You have tested your credentials using the Test Authentication call.
- You are aware of what fields and countries you are configured for from the Integration Guide
API Endpoint
For ease of integration, our Watchlist Screening product is integrated into the same Trulioo endpoint as our Person Match and Business Verification products. In addition, Watchlist Screening can be configured to run as part of a Person Match/Business Verification transaction or a separate screening-only check.
<<endpoint>>/v3/verifications/verify
Sample API Request
{
"DataFields": {
"PersonInfo": {
"FirstGivenName": "Tom",
"MiddleName": "Marvolo",
"FirstSurName": "Riddle",
"DayOfBirth": 31,
"MonthOfBirth": 12,
"YearOfBirth": 1926
}
},
"CountryCode": "UK",
"VerboseMode": "True"
}
POST v3/verifications/verify
Host: <<endpoint>>
Authorization: OAuth
Content-Type: application/json
{
"DataFields": {
"PersonInfo": {
"FirstGivenName": "Vladimir",
"FirstSurName": "Putin",
"DayOfBirth": 7,
"MonthOfBirth": 10,
"YearOfBirth": 1952
}
},
"ConfigurationName": "Identity Verification",
"ConsentForDataSources": [],
"verificationType":"Live",
"packageId":"xxxxx",
"CountryCode": "US",
"VerboseMode": "True"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n\"DataFields\": {\r\n \"PersonInfo\": {\r\n \"FirstGivenName\": \"Vladimir\",\r\n \"FirstSurName\": \"Putin\",\r\n \"DayOfBirth\": 7,\r\n \"MonthOfBirth\": 10,\r\n \"YearOfBirth\": 1952\r\n }\r\n},\r\n\"AcceptTruliooTermsAndConditions\": true,\r\n\"CountryCode\": \"US\",\r\n\"VerboseMode\": \"True\"\r\n}");
Request request = new Request.Builder()
.url("<<endpoint>>/v3/verifications/verify")
.method("POST", body)
.addHeader("Authorization", "Basic ACCESS_TOKEN")
.build();
Response response = client.newCall(request).execute();
Trulioo Watchlist Response
| NOTE: To see the WatchlistHitDetails Object you must set VerboseMode:true in the request. |
|---|
Sample API Response
{
"TransactionID": "d932a341-f367-40aa-9963-ab9317f2ffd7",
"UploadedDt": "2022-05-02T16:41:42",
"CountryCode": "UK",
"ProductName": "Identity Verification",
"Record": {
"TransactionRecordID": "202ae996-5d61-8841-35e6-eab0028e8bc1",
"RecordStatus": "nomatch",
"DatasourceResults": [
{
"DatasourceName": "Advanced Watchlist",
"DatasourceFields": [],
"AppendedFields": [
{
"FieldName": "WatchlistState",
"Data": "Potential Hit"
},
{
"FieldName": "WatchlistData",
"Data": {
"num_WL_hits": 2,
"num_AM_hits": 2,
"num_PEP_hits": 1
}
},
{
"FieldName": "WatchlistHitDetails",
"Data": {
"WL_results": [{
"score": 1,
"individualName": "Tom Marvolo Riddle",
"aliasList": "Lord Voldemort; You-Know-Who; He-Who-Must-Not-Be-Named; The Dark Lord",
"identifier": "Unique ID: HW32189 | Azkaban ID: 14196",
"subjectMatched": "Tom Marvolo Riddle",
"dateOfBirth": "31/12/1926",
"nationality": "British",
"sourceListType": "Ministry of Magic Sanctions List",
"sourceRegion": "Europe",
"remarks": "Date Designated: 06/07/1945 | Last Updated: 18/12/1995 | Positions: Chief Death Eater",
"caution": "Sanctions Imposed: Asset freeze, Travel Ban, No Broom List",
"URL": "https://www.wizardingworld.com/"
},
{
"score": 0.95,
"individualName": "Tom Riddle",
"aliasList": "Lord Voldemort; The Dark Lord",
"identifier": null,
"subjectMatched": "Tom Riddle",
"dateOfBirth": "31/12/1926",
"nationality": "British",
"sourceListType": "The Magical Congress of the United States of America Sanctions List",
"sourceRegion": "North America",
"remarks": "Date Designated: 06/07/2020 | Last Updated: 18/12/2021 | Positions: Head of the Investigative Committee of Russia",
"caution": "Sanctions Imposed: Asset freeze, Travel Ban",
"URL": "https://www.wizardingworld.com/"
}
],
"AM_results": [{
"score": 0.95,
"subjectMatched": "Tom Riddle",
"text": "Hogwarts increases security against former student Tom Riddle",
"URL": "https://thedailyprophet.net/"
},
{
"score": 0.90,
"subjectMatched": "Voldemort",
"text": "Death Eater Terror Continues as Voldemort returns",
"URL": "https://thedailyprophet.net/"
}
],
"PEP_results": [{
"score": 1,
"name": "Tom Marvolo Riddle",
"dateOfBirth": "31/12/1926",
"country": "United Kingdom",
"professionalHistory": ["Lord Voldemort", "You-Know-Who", "He-Who-Must-Not-Be-Named", "The Dark Lord"],
"URL": "https://harrypotter.fandom.com/wiki/Tom_Riddle",
"PEPRelation": "Name",
"PEPType": 0
}]
},
"Errors": [],
"FieldGroups": []
}
],
"Errors": [],
"Rule": {
"RuleName": "Category 3 KYC v3",
"Note": "Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored"
}
},
"Errors": []
}
Sample API Response
{
"TransactionID": "d932a341-f367-40aa-9963-ab9317f2ffd7",
"UploadedDt": "2022-05-02T16:41:42",
"CountryCode": "UK",
"ProductName": "Identity Verification",
"Record": {
"TransactionRecordID": "202ae996-5d61-8841-35e6-eab0028e8bc1",
"RecordStatus": "nomatch",
"DatasourceResults": [
{
"DatasourceName": "Advanced Watchlist",
"DatasourceFields": [],
"AppendedFields": [
{
"FieldName": "WatchlistState",
"Data": "Potential Hit"
},
{
"FieldName": "WatchlistData",
"Data": {
"num_WL_hits": 2,
"num_AM_hits": 2,
"num_PEP_hits": 1
}
},
{
"FieldName": "WatchlistHitDetails",
"Data": {
"WL_results": [{
"score": 1,
"individualName": "Tom Marvolo Riddle",
"aliasList": "Lord Voldemort; You-Know-Who; He-Who-Must-Not-Be-Named; The Dark Lord",
"identifier": "Unique ID: HW32189 | Azkaban ID: 14196",
"subjectMatched": "Tom Marvolo Riddle",
"dateOfBirth": "31/12/1926",
"nationality": "British",
"sourceListType": "Ministry of Magic Sanctions List",
"sourceRegion": "Europe",
"remarks": "Date Designated: 06/07/1945 | Last Updated: 18/12/1995 | Positions: Chief Death Eater",
"caution": "Sanctions Imposed: Asset freeze, Travel Ban, No Broom List",
"URL": "https://www.wizardingworld.com/"
},
{
"score": 0.95,
"individualName": "Tom Riddle",
"aliasList": "Lord Voldemort; The Dark Lord",
"identifier": null,
"subjectMatched": "Tom Riddle",
"dateOfBirth": "31/12/1926",
"nationality": "British",
"sourceListType": "The Magical Congress of the United States of America Sanctions List",
"sourceRegion": "North America",
"remarks": "Date Designated: 06/07/2020 | Last Updated: 18/12/2021 | Positions: Head of the Investigative Committee of Russia",
"caution": "Sanctions Imposed: Asset freeze, Travel Ban",
"URL": "https://www.wizardingworld.com/"
}
],
"AM_results": [{
"score": 0.95,
"subjectMatched": "Tom Riddle",
"text": "Hogwarts increases security against former student Tom Riddle",
"URL": "https://thedailyprophet.net/"
},
{
"score": 0.90,
"subjectMatched": "Voldemort",
"text": "Death Eater Terror Continues as Voldemort returns",
"URL": "https://thedailyprophet.net/"
}
],
"PEP_results": [{
"score": 1,
"name": "Tom Marvolo Riddle",
"dateOfBirth": "31/12/1926",
"country": "United Kingdom",
"professionalHistory": ["Lord Voldemort", "You-Know-Who", "He-Who-Must-Not-Be-Named", "The Dark Lord"]
}]
},
"Errors": [],
"FieldGroups": []
}
],
"Errors": [],
"Rule": {
"RuleName": "Category 3 KYC v3",
"Note": "Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID) MiddleName Ignored"
}
},
"Errors": []
}