Senior Political Figures (SPFPlus) service

 

SPFPlus service checks if a specified person is a senior political figure (cabinet level or equivalent). 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

<SPFPlusCheckResult>
<MatchResults> <CheckMatch>
<BirthDay /> <BirthMonth /> <BirthYear /> <DateOfBirthMatchScore /> <MatchType>Unknown</MatchType> <Name>Robert Gabriel MUGABE Robert Gabriel MUGABE</Name> <NameMatchScore>85</NameMatchScore> <ProfileId>SANC-6b1a02d6-63b0-7f5d-4a5d-4fb2a0862082</ProfileId> </CheckMatch> </MatchResults> </SPFPlusCheckResult>

Transaction Result

HaltTriggered False
ServiceTransactionResult
  • Success
  • SuccessNoResultsNo matches found
  • ServiceFailureError
  • ClientErrorInsufficientInformation Required field not supplied - NameQuery or Forename / Surname
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
  • Pass
  • NotApplicable - No search occurred to match against
  • Fail MissingMandatoryField or PatternNotMatched

 


 

Property Name Type Description
BirthDay
String
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.
DayOfBirthMatchScore
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 "David Cameron":
The SPFPlusCheckResult will return the results matching a non-sandboxed call with this name query.
The corresponding ServiceTransactions will show the following properties:

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


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