WatchList is a PEP and Sanction list lookup for due diligence checks. The service sees if a person is listed on any PEP or Sanction lists.
PEP (Politically Exposed Person) means “in a prominent public position or a close relative of someone who is.”
Note : PEP match can be a “PEPs by relation”, also known as RCA (Relatives or Close Associates)
Person check
1. Start session
POST to
Test environment: https://test-gateway.zignsec.com/core/api/sessions/identity_check/watchlist_light
Production environment: https://gateway.zignsec.com/core/api/sessions/identity_check/watchlist_light
1.1 Request example
POST https://test-gateway.zignsec.com/core/api/sessions/identity_check/watchlist_light
Content-Type: application/json
Authorization: 12345678-YOUR-ACCESS-TOKEN-5352305c9fb0
Content-Length: 725
{
"metadata": {
"country": "US",
"date_of_birth": "1946-06-14",
"first_name": "Donald",
"gender": "Male",
"last_name": "Trump",
"middle_name": "John",
"original_name": "",
"scan_settings": {
"excluded_list": [
"Un"
],
"included_list": [
],
"list_type": "All",
"match_rate": 50
}
},
"relay_state": "string",
"webhook": "string"
}
1.2 Request Parameters
| Parameter | Description | Required |
|---|---|---|
country | country example : US, SE etc | |
first_name | First name | Yes |
last_name | Last name | Yes |
middle_name | Middle name if available. Multiple middle names must be separated by spaces only and contain no commas (,) | No |
original_name | OriginalName can either be the person’s full name in Non-Latin/Roman based language (e.g. Cyrillic, Arabic, Chinese etc) or the full Latin-based name if you are unable to separate based on First, Middle and Last Name | |
gender | Gender. Can be “Male” or “Female”. | No |
date_of_birth | Date of birth (YYYY-MM-DD or YYYYMMDD) or Year of birth (YYYY) | No |
excluded_list | If you wish to exclude particular sanction lists from your scan use excludedLists. Only one of the two lists can have a value Sanction list [Un – UN – United Nations Sanctions List, Nsdn – US – OFAC Consolidated Sanctions List, Sdn – US – OFAC Specially Designated Nationals (SDN) List, Eu – EU – Financial Sanctions List, UkSl – UK – Sanctions List, Uk – UK – HMT Financial Sanctions List, Au – AU – DFAT Consolidated Sanction list, Seco – CH – SECO Sanction List, Int – Interpol Wanted List, Sema – CA – Consolidated Canadian Autonomous Sanctions List, Bis – US – Bureau of Industry and Security List, Aeca – US – Department of State AECA Debarred List, Prolif – US – Department of State Nonproliferation Sanctions List, Wbil – World Bank – Ineligible Firms and Individuals List, Other – Other Lists] | |
included_list | Use includedLists if you want to scan only over a specified sanction lists. Sanction list [Un – UN – United Nations Sanctions List, Nsdn – US – OFAC Consolidated Sanctions List, Sdn – US – OFAC Specially Designated Nationals (SDN) List, Eu – EU – Financial Sanctions List, UkSl – UK – Sanctions List, Uk – UK – HMT Financial Sanctions List, Au – AU – DFAT Consolidated Sanction list, Seco – CH – SECO Sanction List, Int – Interpol Wanted List, Sema – CA – Consolidated Canadian Autonomous Sanctions List, Bis – US – Bureau of Industry and Security List, Aeca – US – Department of State AECA Debarred List, Prolif – US – Department of State Nonproliferation Sanctions List, Wbil – World Bank – Ineligible Firms and Individuals List, Other – Other Lists] | |
list_type | [All – All, Pep – PEP, Sanction – Sanction] | |
match_rate | matchRate is a percentage from 1-100, which indicates how closely the name being checked matches the name on the matching watchlist profile, with 1% being not close and 100% being very close. If you enter the optional field country and it does not match the Emerald database, the match rate will be reduced by 50% | |
relay_state | Optional Custom Parameter to be included in webhook calls | No |
webhook | A webhook in web development is a method of augmenting or altering the behavior of a web page or web application with custom callbacks | No |
1.3 Response example
{
"data": {
"errors": [],
"id": "9d395552-d91c-4c39-a62e-1bb13443c637",
"result": {
"matches": [
{
"entity": {
"addresses": [],
"category": "PEP",
"children": [
"Ivanka Trump",
"Donald Trump Jr.",
"Eric Trump",
"Tiffany Trump",
"Barron Trump"
],
"citizenship": "United States of America",
"contacts": [
{
"type": "Twitter username",
"value": "POTUS45"
},
{
"type": "Instagram username",
"value": "realdonaldtrump"
},
{
"type": "Facebook profile ID",
"value": "DonaldTrump"
},
{
"type": "Facebook profile ID",
"value": "POTUS45"
}
],
"datesOfBirth": [
{
"date": "1946-06-14"
}
],
"father": "Fred Trump",
"firstName": "Donald",
"gender": "Male",
"identities": [],
"images": [
"http://commons.wikimedia.org/wiki/Special:FilePath/Donald%20Trump%20official%20portrait.jpg"
],
"lastName": "Trump",
"links": [
{
"type": "Official Web Site",
"url": "https://www.donaldjtrump.com/"
}
],
"mother": "Mary Anne MacLeod Trump",
"name": "Donald Trump",
"nationality": "",
"occupations": [
"writer",
"actor",
"businessperson",
"politician",
"entrepreneur",
"investor",
"business magnate",
"television presenter",
"chief executive officer",
"real estate entrepreneur",
"non-fiction writer",
"film producer",
"restaurateur",
"television producer",
"game show host",
"real estate developer",
"conspiracy theorist"
],
"originalScriptNames": [],
"otherNames": [
{
"name": "Individual 1",
"type": "Also Known As"
},
{
"name": "John Miller",
"type": "Also Known As"
},
{
"name": "Trump",
"type": "Also Known As"
},
{
"name": "John Barron",
"type": "Also Known As"
},
{
"name": "Donald John Trump",
"type": "Also Known As"
},
{
"name": "David Dennison",
"type": "Also Known As"
},
{
"name": "DJT",
"type": "Also Known As"
},
{
"name": "Donald J Trump",
"type": "Also Known As"
},
{
"name": "Donald J. Trump",
"type": "Also Known As"
},
{
"name": "Mr Trump",
"type": "Also Known As"
},
{
"name": "POTUS 45",
"type": "Also Known As"
},
{
"name": "President Donald J Trump",
"type": "Also Known As"
},
{
"name": "President Donald J. Trump",
"type": "Also Known As"
},
{
"name": "President Donald John Trump",
"type": "Also Known As"
},
{
"name": "President Donald Trump",
"type": "Also Known As"
},
{
"name": "President Trump",
"type": "Also Known As"
},
{
"name": "The Donald",
"type": "Also Known As"
},
{
"name": "Donald John Trump",
"type": "birth name"
},
{
"name": "Donald Trump",
"type": "name in native language"
}
],
"places": [
{
"country": "United States of America",
"location": "Palm Beach",
"type": "residence"
},
{
"country": "United States of America",
"location": "Trump Tower",
"type": "residence"
},
{
"country": "United States of America",
"location": "Mar-a-Lago",
"type": "residence"
},
{
"country": "United States of America",
"location": "New York",
"type": "residence"
},
{
"country": "United States of America",
"location": "Manhattan",
"type": "residence"
},
{
"country": "United States of America",
"location": "Queens",
"type": "residence"
},
{
"country": "United States of America",
"location": "White House",
"type": "residence"
},
{
"country": "United States of America",
"location": "Jamaica Estates",
"type": "residence"
},
{
"location": "New York City",
"type": "work location"
},
{
"location": "Washington, D.C.",
"type": "work location"
}
],
"placesOfBirth": [
{
"country": "United States of America",
"location": "Jamaica Hospital Medical Center"
}
],
"politicalParties": [
{
"from": "2012-04-01",
"title": "Republican Party",
"to": ""
},
{
"from": "2009-09-01",
"title": "Republican Party",
"to": "2011-12-01"
},
{
"from": "1987-07-01",
"title": "Republican Party",
"to": "1999-10-01"
},
{
"from": "1999-10-01",
"title": "Independence Party of America",
"to": "2001-08-01"
},
{
"from": "2001-08-01",
"title": "Democratic Party",
"to": "2009-09-01"
}
],
"referenceType": "PEP",
"references": [],
"roles": [
{
"from": "2017-01-20",
"title": "President of the United States",
"to": "2021-01-20"
},
{
"from": "1971",
"title": "chairperson",
"to": ""
},
{
"from": "",
"title": "director",
"to": ""
},
{
"from": "1971",
"title": "president",
"to": ""
},
{
"from": "2016-11-09",
"title": "President-elect of the United States",
"to": "2017-01-20"
}
],
"siblings": [
"Maryanne Trump Barry",
"Robert Trump",
"Elizabeth Trump Grau",
"Fred Trump Jr."
],
"sources": [],
"spouse": "Melania Trump",
"summary": "Height: 74.0",
"updateAt": "2022-03-26"
},
"matchRate": 100
},
{
"entity": {
"addresses": [],
"category": "RCA",
"children": [
"Tristan Milos Trump",
"Chloe Sophia Trump",
"Spencer Frederick Trump",
"Kai Madison Trump",
"Donald Trump III"
],
"citizenship": "United States of America",
"contacts": [
{
"type": "Twitter username",
"value": "DonaldJTrumpJr"
},
{
"type": "Instagram username",
"value": "donaldjtrumpjr"
},
{
"type": "Facebook profile ID",
"value": "DonaldJTrumpJr"
}
],
"datesOfBirth": [
{
"date": "1977-12-31"
}
],
"father": "Donald Trump",
"firstName": "Donald",
"gender": "Male",
"identities": [],
"images": [
"http://commons.wikimedia.org/wiki/Special:FilePath/Donald%20Trump%2C%20Jr.%20%2848513758216%29%20%28cropped%29.jpg"
],
"lastName": "Trump",
"links": [
{
"type": "Official Web Site",
"url": "http://www.trump.com/"
}
],
"mother": "Ivana Trump",
"name": "Donald Trump Jr.",
"nationality": "",
"occupations": [
"businessperson",
"television presenter",
"entrepreneur"
],
"originalScriptNames": [],
"otherNames": [
{
"name": "DJTJ",
"type": "Also Known As"
},
{
"name": "Don Jr",
"type": "Also Known As"
},
{
"name": "Don Jr.",
"type": "Also Known As"
},
{
"name": "Don Trump Jr",
"type": "Also Known As"
},
{
"name": "Donald J. Trump Jr.",
"type": "Also Known As"
},
{
"name": "Donald J. Trump, Jr.",
"type": "Also Known As"
},
{
"name": "Donald John \"Don\" Trump Jr.",
"type": "Also Known As"
},
{
"name": "Donald John Trump Jr.",
"type": "Also Known As"
},
{
"name": "Donald John Trump, Jr.",
"type": "Also Known As"
},
{
"name": "Donald Trump Jr",
"type": "Also Known As"
},
{
"name": "Donald Trump Junior",
"type": "Also Known As"
},
{
"name": "Donald Trump, Jr.",
"type": "Also Known As"
},
{
"name": "Trump Jr",
"type": "Also Known As"
},
{
"name": "Trump Jr.",
"type": "Also Known As"
},
{
"name": "Donald John Trump",
"type": "birth name"
}
],
"places": [
{
"country": "United States of America",
"location": "New York City",
"type": "residence"
}
],
"placesOfBirth": [
{
"country": "United States of America",
"location": "Manhattan"
}
],
"politicalParties": [
{
"from": "",
"title": "Republican Party",
"to": ""
}
],
"referenceType": "PEP",
"references": [],
"roles": [],
"siblings": [
"Eric Trump",
"Ivanka Trump",
"Tiffany Trump",
"Barron Trump"
],
"sources": [],
"spouse": "Vanessa Trump",
"updateAt": "2022-03-19"
},
"matchRate": 60
}
],
"numberOfMatches": 2,
"numberOfPepMatches": 2,
"numberOfSipMatches": 0
},
"status": "Finished"
}
}
1.4 Response Parameters
errors | A JSON object that contains information on error conditions that might have resulted from the request, in an array of property-value pairs. If multiple errors occur, a pair of parameters is returned for each error. code Code for the error. List of codes is in table below. description A string that describes the type of error that occurred. If no errors occur, then this object is empty. errors : [] |
id | A unique session identifier generated for each workflow instance. |
deceased | Identifies if the person is deceased |
deceased_date | Deceased date |
first_name | First name |
gender | [Male, Female] |
places | address, city, country, location, type |
occupations | occupations |
nationality | the status of belonging to a particular nation |
numberOfMatches | Number of matches |
number_of_pep_matches | Number of PEP Matches |
number_of_sip_matches | Number of SIP Matches |
status | Created, Finished, Failed Created : Request has started |
