Skip to content
On this page

W2 Data Ekyc Singlesource 043

About the 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

Product Code: W2-DATA-EKYC-GLOBAL_SINGLESOURCE-043

Does this service leave a credit search Footprint? Yes

Request

Query Data

The following QueryData properties pertain to this service

Property NameTypeMin LengthMax LengthOptional/MandatoryNotesAccepted Characters
CityString120OptionalAll but not ,
CountryString33Mandatory** A 3 character ISO country code i.e. GBR, USA etc. See appendix for a full list of supported countries.Only ISO Country Codes
CountyString120Optional** This is a mandatory field if the Country code is set to IRL. Please remove the "County" from the name (e.g to send "County Wexford", just use "Wexford")All but not ,
DayOfBirthInteger12MandatoryNumbers only greater than 0
ForenameString115Mandatory
GenderString11Optional** Either M or F (This is case sensitive and needs to be uppercase)
HouseName/HouseNumberString126Mandatory** Either house name or house number must be supplied may also include Flat number i.e. Flat 1, 4All but not ,
MiddleNamesString15Optional
MonthOfBirthInteger12MandatoryNumbers only greater than 0
PersonalIdString49Optional** US only, if this has been configured as required but is omitted, then the only possible results will be Fail or Refer
PostcodeString38Mandatory** Optional if Country is set to IRL (Ireland)All but not ,
RegionString22Optional** Mandatory if Country is set to USA. Requires a valid 2 character state code. (e.g NY)
StreetString140Mandatory** Optional if Country is set to GBR (United Kingdom)All but not ,
SurnameString130Mandatory
YearOfBirthInteger14MandatoryNumbers only greater than 0

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

Example Requests

Ireland Example:

json
"Data": {
	"Country": "IRL",
	"County": "Wexford",
	"DayOfBirth": 13,
	"Forename": "Teague",
	"HouseNumber": "8",
	"MonthOfBirth": 1,
	"Street": "Hospital Road",
	"Surname": "Mullen",
	"YearOfBirth": 1949
}

United States Example:

json
  "Data": {
  	"Country": "USA",
  	"DayOfBirth": 28,
  	"Forename": "Susan",
  	"HouseNumber": "2071",
  	"MonthOfBirth": 9,
  	"Postcode": "34744",
  	"Region": "FL",
  	"PersonalId": "537430927",
  	"Street": "McDonald Avenue",
  	"Surname": "Barker",
  	"YearOfBirth": 1959
  }

United Kingdom Example:

json
  "Data": {
  	"Country": "GBR",
  	"DayOfBirth": 25,
  	"Forename": "Gabriel",
  	"HouseNumber": "74",
  	"MonthOfBirth": 3,
  	"Postcode": "LE67 8WE",
  	"Street": "Golf Road",
  	"Surname": "Peacock",
  	"YearOfBirth": 1987
}

Response

Example Response

json
      "w2DataEkycGlobal043Result": {
       	"rawResponse": "{\"DataSource\":\"TESTDB\",\"FirstNameMatch\":\"Full\",\"SurnameMatch\":\"Full\",\"DobMatch\":\"Full\",\"AddressMatch\":\"Full\",\"SsnMatch\":null}",
       	"ssnMatch": false,
       	"dataSources": [{
       			"allowMultipleRecordsAsSeparateDataSources": true,
       			"matchingCriteria": "NameAndAddressAndDateOfBirth",
       			"numberOfMatches": 1,
       			"source": 11
       		}
       	],
       	"interpretResult": "Pass",
       	"message": "Matching performed using 11 sources as per profile",
       	"transactionResult": "Success"
       }

Response breakdown

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

PropertyValue
HaltTriggeredFalse
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- NotPerformed - An error occurred and the search was not performed
- Pass
- Fail
- Inconclusive
- NotApplicable - Validation has failed, please check ValidationResult for further details.
ServiceTransactionResultMessageUsually 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

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.

Example Request

json
{
    "Bundle": "W2_DATA_EKYC_GLOBAL_SINGLESOURCE_043",
    "Data": {
        "Forename": "Michael",
        "Surname": "Tschank",
        "HouseNumber": "51",
        "Street": "Nobilegasse",
        "City":"Wien",
        "Postcode": "1150"
    },
    "Options": {
        "Sandbox": "true"
    },
    "ClientReference": "your-client-reference"
}

Sandbox cases

These are the sandbox options for these service. Learn about our Sandbox here

Click on a sandbox case to view the request and response

Country Data

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

ISO CodeCountry
ALBAlbania
AREUnited Arab Emirates
ARGArgentina
ARMArmenia
AUSAustralia
AZEAzerbaijan
BELBelgium
BENBenin
BGRBulgaria
BIHBosnia And Herzegovina
BLRBelarus
BMUBermuda
BRNBrunei Darussalam
CANCanada
CHESwitzerland
CHLChile
CHNChina
CIVCôte D`ivoire/Ivory Coast
CMRCameroon
CYMCayman Islands
CZECzech Republic
DEUGermany
DNKDenmark
EGYEgypt
ESPSpain
ESTEstonia
FINFinland
FRAFrance
GBRUnited Kingdom
GEOGeorgia
GIBGibraltar
GRCGreece
HKGHong Kong
HRVCroatia
HUNHungary
IDNIndonesia
INDIndia
IRLIreland
IRNIran, Islamic Republic Of
ISLIceland
ISRIsrael
ITAItaly
KAZKazakstan
KGZKyrgyzstan
LIELiechtenstein
LTULithuania
LUXLuxembourg
LVALatvia
MARMorocco
MCOMonaco
MDAMoldova, Republic Of
MEXMexico
MYSMalaysia
NLDNetherlands
NORNorway
NZLNew Zealand
OMNOman
PAKPakistan
POLPoland
PRIPuerto Rico
PRTPortugal
PSEPalestine
QATQatar
ROURomania
RUSRussian Federation
SGPSingapore
SVKSlovakia
SWESweden
TJKTajikistan
TKMTurkmenistan
TURTurkey
UKRUkraine
USAUnited States
UZBUzbekistan
VENVenezuela
ZAFSouth Africa