Politically Exposed Persons service

 

PEPDesk service checks if a specified person is a politically exposed person, i.e. they are in a prominent public position or a close relative of someone who is. 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

<PEPDeskCheckResult>
	 <!-- One or more of these --> 
	 <MatchResults>
		<CheckMatch>
		   <BirthDay />
		   <BirthMonth />
		   <BirthYear />
		   <DateOfBirthMatchScore />
		   <MatchType>Unknown</MatchType>
		   <Name>Robert Gabriel Mugabe Mugabe, Robert G.; Mugabe, Robert</Name>
		   <NameMatchScore>85</NameMatchScore>
		   <ProfileId>a34c862e-a0b9-28a4-49ca-f3cdd4ec7f54</ProfileId>
		</CheckMatch>
	 </MatchResults>
</PEPDeskCheckResult>

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.

Transaction Result

HaltTriggered False
ServiceTransactionResult
  • Success
  • SuccessIncompleteResults Too many matches on the search criteria and the results have been truncated
  • SuccessNoResults No matches found
  • ServerErrorGeneralError An error occurred
  • ClientErrorInformationFormatInvalidEither invalid birth data or blank search query
ServiceInterpretResult
  • OneResult
  • MultipleResults
  • NoResults
  • NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessage Usually empty, can contain optional information such as too many matches etc.
ValidationResult
  • NotApplicable - No search occurred to match against
  • Fail MissingMandatoryField or PatternNotMatched

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

This service uses Sandbox V2.

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

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

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


For all other name queries:
An empty, non-null PEPDeskCheckResult 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