W2 DATA EKYC GLOBAL SINGLESOURCE 043

A global identity verification service.

W2 DATA EKYC GLOBAL SINGLESOURCE 043 Service

W2 Data Ekyc Global SingleSource 043 is a global identity verification service that can be performed for 169 countries and matches on a single datasource.

Contents

The following QueryData properties pertain to this service, please note that the fields MUST be in the same order as shown below.

Property Name Type Length Optional/Mandatory Notes
City String 20 Optional  
Country String 3 Mandatory A 3 character ISO country code i.e. GBR, USA etc. See appendix for a full list of supported countries.
County String 20 Optional This is a required field if the Country code is set to IRL
DayOfBirth Integer 2 Mandatory  
Forename String 15 Mandatory  
Gender String 1 Mandatory Either M or F (This is case sensitive and needs to be uppercase)
HouseName/HouseNumber String 26 Optional Either house name or house number must be supplied may also include Flat number i.e. Flat 1, 4
MiddleNames String 15 Optional  
MonthOfBirth Integer 2 Mandatory  
PersonalId String 9 Optional US only, if this has been configured as required but is omitted, then the only possible results will be Fail or Refer
Postcode String 8 Mandatory Optional if Country is set to IRL (Ireland)
Region String 2 Optional US only contains a valid 2 character state code.
Street String 40 Mandatory Optional if Country is set to GBR (United Kingdom)
Surname String 30 Mandatory  
YearOfBirth Integer 2 Mandatory  

After performing the search, the validation result (pass, fail, etc.) will be part of the <TransactionInformation> returned for the service call. 

Request

 The following are example SOAP requests to the W2 Data Ekyc Single Source 043 Service:

Ireland Example:

<QueryData>
<City>Dublin</City>
<Country>IRL</Country>
<County>CORK</County>
<DayOfBirth>16</DayOfBirth>
<Forename>Oscar</Forename>
<Gender>M</Gender>
<HouseNumber>18</HouseNumber>
<MiddleNames>Example</MiddleNames>
<MonthOfBirth>10</MonthOfBirth>
<Postcode>32206</Postcode>
<Street>Library Street</Street>
<Surname>Wilde</Surname>
<YearOfBirth>1971</YearOfBirth>
</QueryData>
United States Example:
<QueryData>
<City>Jacksonville</City>
<Country>USA</Country>
<DayOfBirth>09</DayOfBirth>
<Forename>William</Forename>
<Gender>M</Gender>
<HouseNumber>1812</HouseNumber>
<MiddleNames>Example</MiddleNames>
<MonthOfBirth>04</MonthOfBirth>
<Postcode>32206</Postcode>
<Region>TX</Region>
<PersonalId>123456</PersonalId>
<Street>Overture Drive</Street>
<Surname>Tell</Surname>
<YearOfBirth>1958</YearOfBirth>
</QueryData>

United Kingdom Example:
<QueryData>
<City>Newport</City>
<Country>GBR</Country>
<DayOfBirth>25</DayOfBirth>
<Forename>Isaac</Forename>
<Gender>M</Gender>
<HouseNumber>18</HouseNumber>
<MiddleNames>Example</MiddleNames>
<MonthOfBirth>12</MonthOfBirth>
<Postcode>NP201FU</Postcode>
<Street>Gravity Terrace</Street>
<Surname>Newton</Surname>
<YearOfBirth>1997</YearOfBirth>
</QueryData>

Response

The following shows the basic schema for the <W2DataEkycSingleSource043Result> object that is returned in the <ServiceResult> Section of the <ProcessRequestResult> object. 

<W2DataEkycGlobal043Result>
<DataSources>
<!-- An array of MatchingSource elements -->
<MatchingSource>
<AllowMultipleRecordsAsSeparateDataSources>
{ true | false }
</AllowMultipleRecordsAsSeparateDataSources>
<MatchingCriteria>
{
NameAndPersonalId | NameAndAddress | NameAndDateOfBirth |
NameAndAddressAndDateOfBirth
}
</MatchingCriteria>
<NumberOfMatches>
{ 0 - 1 }
<NumberOfMatches>
<Source>
{
0 = NotAssigned
1 = ElectoralRoll
8 = Credit
9 = Government
11 = Consumer
12 = Utility
15 = Postal
}
<Source>
</MatchingSource>
</DataSources>
<InterpretResult>
{
NotPerformed | Pass | Fail | Refer | NoInterpretPerformed
}
</InterpretResult>
<Message>
{ A message containing additional information about the call }
</Message>
<TransactionResult>
{
None | Success | SuccessNoResults | SuccessIncompleteResults |
MultipleChoices | ClientErrorInformationFormatInvalid | ClientErrorInsufficientInformation |
NotExecutedDueToPreviousHalt | ServerErrorGeneralError | ServiceFailureError
}
</TransactionResult>
<RawResponse>
[
{
"DataSource": "DS",
"FirstNameMatch":"Full|Initial|NoMatch",
"SurnameMatch":"Full|Partial|NoMatch",
"DobMatch": "Full|Partial|NoMatch",
"AddressMatch": "Full|Partial|NoMatch",
"SsnMatch": "Full|Partial|NoMatch"
}
]
</RawResponse>
<SsnMatch>true|false</SsnMatch>
</W2DataEkycGlobal043Result>

 Below is some more information about the some of the elements of the response that require explanation:

Datasources = There will only ever be zero or 1 matching source <MatchingSource> element.

AllowMultipleRecordsAsSeparateDataSources = Indicates that two different record matches from the same data source may count as independent sources when formulating the 2 + 2 result. For example, two Teleco results may count as two sources, rather than one, as they would do under normal service circumstances.

MatchingCriteria = Precisely what data has been matched by the data source. E.g. NameAndAddressAndDateOfBirth

NumberOfMatches = Will only ever be zero or 1.

Source = The source of the data match. E.g. Teleco

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
  • ServiceFailureError- Unable to contact third party service
  • ClientErrorInsufficientInformation - Required field not supplied or insufficient/invalid information
  • ClientErrorInformationFormatInvalid - Address fields cannot contain commas
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
  • NotPerformed - No search occurred to match against
  • Fail - MissingMandatoryField or PatternNotMatched

Sandbox mode can be used to test the service. By setting the following query option and sending some the below query data we will return a pre-configured response without actually calling our suppliers.

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions> 

If the Sandbox query option is set to "true" then the following queries will return results. The result of the verification will depend on the configuration of the matching set up during the on-boarding process.

To see the details of the service response of each sandbox case, simply click on it in the table below:

Forename Surname Day Of Birth Month Of Birth Year Of Birth PersonalId (SSN) Flat House Name Number Street County Postcode Region Country
Amantzi Acevedo 12 7 1979 53 Rua do Paseo 41907
Bernadette McLennan 22 12 1972 78 Moira Road Cork IRL
Gabriel Peacock 25 3 1987 74 Golf Road LE67 8WE
Isabelle Warner 3 10 1988 87 Jubilee Drive NR29 3UY
Milla Ingham 30 12 1955 48 Wigley Street 5043
Nuala Keogh 22 11 1980 16 Woodbrook Heights Sligo IRL
Ralph Kaestner 22 12 1948 67 Gruenauer Strasse 21272
Sabine Dupuis 6 8 1983 88 rue Victor Hugo 60200
Susan Barker 28 9 1959 537430927 2071 McDonald Avenue 34744 FL USA
Teague Mullen 13 1 1949 8 Hospital Road Wexford IRL
(Click on a sandbox case to see the service result data here)
        

The following table shows the countries supported by the W2 Global Ekyc Global Singlesource 043 service.

ISO Code Country
ALB Albania
ARE United Arab Emirates
ARG Argentina
ARM Armenia
AUS Australia
AZE Azerbaijan
BEL Belgium
BEN Benin
BGR Bulgaria
BIH Bosnia And Herzegovina
BLR Belarus
BMU Bermuda
BRN Brunei Darussalam
CAN Canada
CHE Switzerland
CHL Chile
CHN China
CIV Côte D`ivoire/Ivory Coast
CMR Cameroon
CYM Cayman Islands
CZE Czech Republic
DEU Germany
DNK Denmark
EGY Egypt
ESP Spain
EST Estonia
FIN Finland
FRA France
GBR United Kingdom
GEO Georgia
GIB Gibraltar
GRC Greece
HKG Hong Kong
HRV Croatia
HUN Hungary
IDN Indonesia
IND India
IRL Ireland
IRN Iran, Islamic Republic Of
ISL Iceland
ISR Israel
ITA Italy
KAZ Kazakstan
KGZ Kyrgyzstan
LIE Liechtenstein
LTU Lithuania
LUX Luxembourg
LVA Latvia
MAR Morocco
MCO Monaco
MDA Moldova, Republic Of
MEX Mexico
MYS Malaysia
NLD Netherlands
NOR Norway
NZL New Zealand
OMN Oman
PAK Pakistan
POL Poland
PRI Puerto Rico
PRT Portugal
PSE Palestine
QAT Qatar
ROU Romania
RUS Russian Federation
SGP Singapore
SVK Slovakia
SWE Sweden
TJK Tajikistan
TKM Turkmenistan
TUR Turkey
UKR Ukraine
USA United States
UZB Uzbekistan
VEN Venezuela
ZAF South Africa