Watchlist Check

Watchlist service checks if a specified person or entity is held within a comprehensive dataset comprising PEP, Sanction, Adverse media content and enforcement watchlists from around the globe. If there are multiple matches, it provides a list of them, up to a limit of 100.

Properties

 The following properties pertain to this service. 

Property Name Type Optional/Mandatory Notes
NameQuery
String
Mandatory The name of the person you are searching for.
NameQueryMatchThreshold
Integer
Optional The minimum name match score to match against. Default is 80 (all matches).
DateOfBirthMatchThreshold
Integer
Optional The minimum date of birth score to match against. Default is null (off). If supplied, at least one component of the date of birth must be supplied.
DayOfBirth
Integer
Optional Used with DateOfBirthMatchThreshold.
MonthOfBirth
Integer
Optional Used with DateOfBirthMatchThreshold.
YearOfBirth
Integer
Optional Used with DateOfBirthMatchThreshold.

Response

The following shows a sample of the <WatchlistCheckResult> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object

<WatchlistCheckResult>
	 <MatchResults>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Person</MatchType>
		   <Name>JOHN SMITH</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>69e10264-4b90-64fe-b4b7-c9dddafd0241</ProfileId>
		</CheckMatch>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Person</MatchType>
		   <Name>JOHN JAMES SMITH</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>cb5f2851-64c0-6866-0ed1-da306e45efb2</ProfileId>
		</CheckMatch>
	 </MatchResults>
</WatchlistCheckResult>

The following table gives some more details about the response.

Property Name Type Description
BirthDay
Integer
The birth day of the record matched against.
BirthMonth
Integer
The birth month of the record matched against.
BirthYear
Integer
 The birth month of the record matched against.
DateOfBirthMatchScore
Integer
The score that this record's date of birth matched the query date.
MatchType
MatchTypeEnum
The type of match where the data is available in the source. See below
Name
String
The name of the record matched against. Depending on the source data there may be multiple names here combined into one.
NameMatchScore
Integer
The score that this record's name matched the query name.
ProfileId
String
A unique reference for a profile that can be subsequently retrieved in full using the ProfileDetails Service.

Notes

The date of birth parameters will be null if no date of birth matching threshold was specified, even if the record has a date of birth, as it reflects the matching that occurred.

More information about the match type

Enumeration Value  Value  Description 
Person 1 The match is a Person.
Entity 2 The match is an Entity.
Unknown 3 The match is of unknown type. This may represent missing data and does not necessarily mean 'other'.
Vessel 4 The match is a vessel (usually maritime).
Aircraft 5 The match is an aircraft.

 

Sandbox

If the Sandbox query option is set to "true" the following entry will be returned in the ServiceResult:

If the NameQuery is entered as "Robert Mugabe":
The WatchlistCheckResult will return the results matching a non-sandboxed call with this name query.
The corresponding ServiceTransactions will show the following properties:

<HaltTriggered> False
<ServiceInterpretResult> MultipleResults
<ServiceTransactionResult> Success
<ServiceTransactionResultMessage> "This call was generated using sandbox mode"
<ValidationResult> Pass

For all other name queries:
An empty, non-null WatchlistCheckResult will be returned.
The corresponding ServiceTransactions will show the following properties:

<HaltTriggered> False
<ServiceInterpretResult> NoResults
<ServiceTransactionResult> SuccessNoResults
<ServiceTransactionResultMessage> "This call was generated using sandbox mode"
<ValidationResult> Pass