Skip to content
On this page

W2 Data EKYC Global 029

Compatible Cases

About the service

W2 Data EKYC Global 029 is a global identity verification service. W2 will combine several sources of data to make a match. We have a default setup for how we combine sources to make a match, which can be configured if needed. Please contact W2 support for more details.

Product Code: W2-DATA-EKYC-GLOBAL-029

Does this service leave a credit search Footprint? Yes

Request

Query Data

The following QueryData elements pertain to this service.

Property NameTypeLengthOptional/MandatoryNotes
CountryString3MandatoryISO 3 letter country code. Available countries listed below.
ForenameString15Mandatory
MiddleNamesString15Optional
SurnameString30Mandatory
GenderStringOptionalMust be 'M' or 'F' if provided
DayOfBirthInteger2Mandatory
MonthOfBirthInteger2Mandatory
YearOfBirthInteger4Mandatory
HouseNameString26Mandatory if no HouseNumber givenMinimum address fields are HouseName or Housenumber as well as the postcode. We advise that more address information be sent if possible as this will improve the chances of a match
HouseNumberString26Mandatory if no HouseName given
FlatString20Optional
StreetString255Optional
RegionString255Optional
CityString100Optional
PostcodeString5Mandatory
Phone NumberString16OptionalPlease provide the phone number as one contiguous set of numbers with no other characters or spaces.
NationalIdString30Depends on country
NationalId Type
(Global029NationalIdType Query option)
String30Depends on country

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

Suported countries

The full list of supported countries with required fields.

CountryCodeNameAddressDate of BirthNational IDPhone Number
ArgentinaARGRequiredOptionalRecommendedRequired
AustraliaAUSRequiredRequiredRequiredOptional + TypeOptional
AustriaAUTRequiredRequiredOptional
BahrainBHR
BelgiumBELRequiredRecommendedRequiredOptional
BrazilBRARequiredRecommendedOptionalRequiredRecommended
CanadaCANRequiredRequiredOptionalOptionalRecommended
ChileCHLRequiredOptionalRequiredRequired
ChinaCHNRequiredOptionalRecommendedRequiredRecommended
ColombiaCOLRequiredOptionalOptionalRequiredOptional
Costa RicaCRIRequiredRecommendedRecommendedRequired
Czech RepublicCZERequiredRequiredOptional
DenmarkDNKRequiredRequiredRequiredRequiredOptional
EgyptEGY
FinlandFINRequiredRequiredRecommendedRequiredOptional
FranceFRARequiredRequiredRecommendedOptional
GermanyDEURequiredRequiredOptionalOptional
GhanaGHARequiredOptionalRequired + TypeOptional
GibraltarGIBRequiredRecommendedOptional
GreeceGRCRequiredRecommendedRecommendedOptional
GuatemalaGTMRequiredRecommendedRecommendedRequired
Hong KongHKGRequiredOptionalRequiredRequiredOptional
IndiaINDRequiredOptionalRecommendedRequired + TypeRecommended
IndonesiaIDNRequiredRequiredRequiredRecommended
IrelandIRLRequiredRequiredRecommendedOptional
ItalyITARequiredRequiredRequiredOptionalOptional
JordanJOR
JapanJPNRequiredRequiredOptional
KenyaKENRequiredOptionalRequiredRequired + TypeOptional
KuwaitKWT
LebanonLBN
LuxembourgLUXRequiredRequiredOptional
MalaysiaMYSRequiredRequiredRequiredRequired
MexicoMEXRequiredOptionalRecommendedRequired
NetherlandsNLDRequiredRequiredRequiredOptional
New ZealandNZLRequiredRequiredRecommended
NigeriaNGARequiredRecommendedRecommendedRequired + TypeRecommended
NorwayNORRequiredRequiredRecommendedOptionalOptional
PeruPERRecommendedRecommendedRecommendedRequired
PhilippinesPHLRequiredOptionalRequiredRequiredRequired
PolandPOLRequiredRequiredRecommendedOptionalOptional
PortugalPRTRequiredRequiredRecommendedOptional
RomaniaROURequiredRequiredRequiredRecommended
Russin FederationRUS
SingaporeSGPRequiredOptionalRequiredRequired
SlovakiaSVKRequiredRequired
South AfricaZAFRequiredRecommendedOptionalRequiredOptional
SpainESPRequiredRequiredRecommendedRecommendedOptional
SwedenSWERequiredRequiredRequiredRequiredOptional
SwitzerlandCHERequiredRequiredRequiredOptional
ThailandTHARequiredRequiredRequiredRequiredRecommended
TurkeyTURRequiredRequiredRequired
United Arab EmiratesARERequiredRequiredOptional
United KingdomGBRRequiredRequiredOptionalOptional
United StatesUSARequiredRequiredRecommendedOptionalOptional
VietnamVNMRequiredRequiredOptionalRequired

National IDs

The table above specifies some countries require a national Id type. This can be provided in the query options section of the request.

The key for the option should be Global029NationalIdType

The available national IDs and national ID types per country are as follows:

CountryNational ID TypeGlobal029NationalIdType query option (if needed)Format ExampleTotal Characters (Including special characters)
ArgentinaDocumento Nacional de Identidad (DNI)105631458
AustraliaAU PassportAUS-PassportP00000008 or 9: 1 or 2 letters followed by 7 digits
AustraliaForeign PassportAUS-ForeignPassport
AustraliaDriver's LicenseAUS-DriversLicence1234567Varies by province/state
BrazilCPF000.000.000-0014
BrazilCNPJ00.000.000/0001-0018
CanadaSocial Insurance Number (SIN)1234567899
ChileRUT / RUN numbersXXXXXXXX-Z10
ChinaResident Identity Card NumberRRRRRRYYYYM MDDSSSC18
ColombiaColombian Personal Identification Number21312343218 or 10 digits
Costa RicaCedula de identidad number0 0000 00009 digits
DenmarkCPRDDMMYY-000011
FinlandPersonal identity codeDDMMYYCZZZQ11
GhanaNew Voter IDGHA-NewVoterID010
GhanaPassportGHA-PassportG00000008
GhanaSSNITGHA-SSNITC00000000000013
GhanaVoter IDGHA-VoterID010
GuatemalaCodigo Unico de Identification (CUI)0000 00000 000013 digits
Hong KongHKIDX123456(A)10 or 11
IndiaPAN NumberIND-PANNumberAAAPL1234C10
IndiaVoter ID (EPIC)IND-VoterIDABC000000010
IndiaDriver's LicenseIND-DriversLicenceHR- 0619850034761 OR HR06 1985003476116
IndonesiaNational ID (Nomor Induk Kependudukan)XXXXXXDDMMY YXXXX16
ItalyCodice FiscaleSSSNNNYYMDD ZZZZX16
Japan"My number"/ Resident Record codeXXXXXXXXXXX11
JordanCivil Identification NumberXXXXXXXXXXXX XX14
KenyaNational IDKEN-NationalID123456781 to 9 digits
KenyaAlien CardKEN-AlienCard06
KenyaPassportKEN-Passport08
KenyaNational ID No PhotoKEN-NationalIDNoPhoto123456781 to 9 digits
KenyaKRA PINKEN-KRAPin123456781 to 9 digits
MalaysiaNRICYYMMDD-SS- 123G14
MexicoCURPHEGG560427MV ZRRL0518
MexicoRFCXXXXXXXXXXXX X13
New ZealandDriver's LicenseVV1234568
NigeriaNational Identification Number (NIN)NGA-NINXXXXXXXXXXX11
NigeriaVoter IDNGA-VoterIDXXXX XXXX XXXX XXXX XXX19
NigeriaDriver's LicenseNGA-DriversLicenceABCXXXXXXXXX12
NigeriaBVNNGA-BVNXXXXXXXXXXX11
NigeriaVirtual National Identification Number (vNIN)NGA-vNINAAXXXXXXXXXX XXXX16
NorwayNational Identity NumberDDMMYYXXXXX11
PeruDocumento Nacional de Identidad (DNI)12345678
PhilippinesPhilID Card Number (PCN)01234567891234 5616
PolandPESEL numberYYMMDDZZZXQ11
RomaniaCod Numeric Personal (CNP)GYYMMDDZZSS SC13
SingaporeNRIC@xxxxxxx#9
South AfricaNational IDYYMMDDSSSSC AZ13
SpainNIF/DNI00000000-A10
SpainNIEX-0000000-A11
SwedenPersonal Identification Number (PIN)YYYYMMDD- NNGC13
ThailandThai Identification Number (TIN)0-0000-0000-00-013
TurkeyTurkish Identification Number1111111111111
United StatesSocial Security Number (SSN)123-45-678911
VietnamNational ID (NIN)XXX G YY XXXXXX9 to 12 digits. 9 digits are older national IDs

Example request

A typical request might look like this:

json
"Data": {
	"Country":"FRA",
  	"City": "Paris",
  	"DayOfBirth": 21,
  	"Forename": "Emmanuel",
  	"HouseNumber": "55",
  	"MonthOfBirth": 12,
  	"Postcode": "75008",
  	"Surname": "Macron",
  	"Street": "Rue du Faubourg",
  	"YearOfBirth": 1977
  }

Response

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

Example Response

Single data source example

json
"w2DataEkycGlobal029Result": {
	"dataSources": [{
			"AllowMultipleRecordsAsSeparateDataSources": false,
			"MatchingCriteria": "NameAndAddress",
			"NumberOfMatches": 1,
			"Source": "Credit"
		}
	],
	"interpretResult": "Pass",
	"Message": "The call was successful",
	"transactionResult": "SuccessIncompleteResults"
}

Multiple data sources example

json
"w2DataEkycGlobal029Result": {
	"dataSources": [{
			"AllowMultipleRecordsAsSeparateDataSources": false,
			"MatchingCriteria": "NameAndAddress",
			"NumberOfMatches": 1,
			"Source": "Credit"
		},{
			"AllowMultipleRecordsAsSeparateDataSources": false,
			"MatchingCriteria": "NameAndAddressAndDateOfBirth",
			"NumberOfMatches": 3,
			"Source": "Government"
		}
	],
	"interpretResult": "Pass",
	"Message": "The call was successful",
	"transactionResult": "SuccessIncompleteResults"
}

Response breakdown

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

DataSources = A collection showing every source of data that was used to formulate the result. Each source is represented by a 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 Insight 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 = The number of matches found by this data source

Source = An integer representing the source of the data match. E.g. 8 = Credit

SourceIdSource MatchedNotes
8CreditData sources containing Credit Bureau, Credit Registry, Credit Monitoring Services and/or other Credit related- data sources which can be used in a country to identify an individual. Examples include Credit Header Records from Bureau data, Credit Monitoring databases, debt management and potentially bankruptcy or financial statements.
9GovernmentA government, public, or public/private partnership providing data sources covering individuals or citizens in a country or countries. Examples include electoral rolls, census data, citizenship databases and real estate or tax data sets.
10CommercialCommercial data is sourced from recent commerce-based transaction data sets and compiled data such as official registers of service professionals. Examples include professional membership organization’s directory data, publishing & media, such as television, subscribers, and distance selling (mail order services) databases.
11ConsumerConsumer and marketing data sources sourced with opt-in permission and approved/permitted use. Examples include digital consumer data sources, direct mail, e-commerce, and loyalty card programs.
12UtilityData sourced from utility billing, customer profile, provisioning and management records for electric, gas, water, sewer, internet, cable and public/private utility companies in a country or region. Examples include Electric bill statements data, customer records on delivery of electrical or gas services and utility databases used for customer communication.
13ProprietaryData sources which are typically either unique to a region or country, private in the nature of the data acquisition, or not easily classified into a specific data source type. Examples include sources which are provided by a data supply where the ultimate origin of the data is a combination of multiple data source types.
14TelecoData sources from telephone/telco companies and their affiliates which include mobile, landline and telephone registry data. Examples include white pages telco registries, HLR/VLR databases, telco customer databases and Customer billing and invoicing records.
15PostalData sources from government and quasi- governmental postal authorities. These data sets may also include delivery data from private couriers, package delivery, and geospatial providers. Examples include Change of Address (COA) databases, receipt and delivery verification databases, and postal address registries.

InterpretResult = The overall verification result, based on what matches were found in the data source against the query data submitted. The possibilities are Pass, Fail or Refer

Message = Gives some more details / context on the verification result

TransactionResult = A diagnostic result showing whether or not any technical errors were experienced during the check. This should always be "Success" unless a technical error has occurred, in which case the verification check will be aborted.

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
- ClientErrorInsufficientInformationRequired field not supplied or insufficient/invalid information
ServiceInterpretResult- OneResult
- MultipleResults
- Fail
- NoResults
- NoInterpretPerformed
- NotPerformed -An error occurred and the search was not performed
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

The following is an example request. Sandbox cases are provided below.

Remember to include the W2 provided API key in the Authorization Header.

If the Sandbox query option is set to "true" then any of the following entities will return a result:

Example sandbox request

json
{
    "Bundle": "KYC_Global_029",
    "Data": {
	"Country":"BEL",
        "Forename": "Michael",
        "Surname": "Tschank",
        "DayOfBirth": 7,
        "MonthOfBirth": 5,
        "YearOfBirth": 1984,
        "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