W2 DocsSPF Plus
Compatible Cases
About the service
Senior Political Figures (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.
Product Code: W2-DATA-SPF-001
Does this service leave a credit search Footprint? No
Request
The following properties pertain to this service.
| Property Name | Type | Optional/Mandatory | Notes |
|---|---|---|---|
| Forename | String | Mandatory if no NameQuery has been provided | The forename of the person you are searching for. Default field used for matching, can be blank if NameQuery used instead. |
| MiddleNames | String | Used with Forename/MiddleNames/Surname option if available | The middlenames of the person you are searching for. Default field used for matching, can be blank if NameQuery used instead or Forename/Surname is supplied. |
| Surname | String | Mandatory if no NameQuery has been provided | The surname of the person you are searching for. Default field used for matching, can be blank if NameQuery used instead. |
| NameQuery | String | Mandatory if no Forename/MiddleNames/Surname has been used | The name of the person you are searching for. Default field used for matching, can be blank if Forename/MiddleNames/Surname used instead. |
| NameQueryMatchThreshold | Integer | - | The minimum name match score to match against. Default is 80 (all matches) |
| DateOfBirthMatchThreshold | Integer | - | 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 | - | Used with DateOfBirthMatchThreshold. |
| MonthOfBirth | Integer | - | Used with DateOfBirthMatchThreshold. |
| YearOfBirth | Integer | - | Used with DateOfBirthMatchThreshold. |
Transaction Result
| Property | Possible values |
|---|---|
| HaltTriggered | False |
| ServiceTransactionResult | Success SuccessNoResults SuccessIncompleteResults - Too many matches generated, results truncated ClientErrorInsufficientInformation - Required field not supplied ClientErrorInformationFormatInvalid - Invalid format in field ServerErrorGeneralError - Error with third party service |
| 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 |
Response
Example Response
json
"SPFPlusCheckResult": {
"MatchResults": [{
"MatchType": "Unknown",
"Name": "KIM Jong Un",
"NameMatchScore": "100",
"ProfileId": "SANC-ee33479b-caaf-1a2d-4d75-e91692143035"
}
]
}Response breakdown
| 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. |
| 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 Profile Details 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.
MatchTypeEnum
Represents the type of match.
| 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. |
Search Filters
Available Filters
Applying Filters:
json
"Options": {
"Sandbox": "false",
"IncludeCountries":"GBR,UDF,SUP - Up to 20 comma delimited countries",
"IgnoreAccentCharacters": "true | false"
}| Filter Type | Description |
|---|---|
| Include Countries | If included, this filter will only return alerts that are on profiles that indicate that the main country of residence/activity is in the included country. Please note that if this filter is used, we advise to also use the 2 additional filters for undefined and supra-Nationals. This will include alerts generated for subjects that cannot be readily assigned to a country. |
| Ignore Accented Characters | When applied, this setting will suppress any accented characters in a record to their standard base english character. i.e. Pierre André would becomes Pierre Andre. (This is false by default) |
Sandbox
Example Request - SPF Plus
json
{
"Bundle": "KYC_SPF",
"Data": {
"NameQuery": "David Cameron"
},
"Options": {
"Sandbox": "true"
},
"ClientReference": "your-client-reference"
}If the Sandbox query option is set to "true" the following entry will be returned in the ServiceResult:
Example Response for "David Cameron":
json
{
"HaltTriggered": "False",
"ServiceInterpretResult": "Multiple Results",
"ServiceTransactionResult": "Success",
"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
"ValidationResult": "Pass"
}Example Response for all OTHER name queries:
json
{
"HaltTriggered": "False",
"ServiceInterpretResult": "NoResults",
"ServiceTransactionResult": "SuccessNoResults",
"ServiceTransactionResultMessage": "This call was generated using sandbox mode",
"ValidationResult": "Pass"
}