W2 Data EKYC Global 029
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 Name | Type | Length | Optional/Mandatory | Notes |
---|---|---|---|---|
Country | String | 3 | Mandatory | ISO 3 letter country code. Available countries listed below. |
Forename | String | 15 | Mandatory | |
MiddleNames | String | 15 | Optional | |
Surname | String | 30 | Mandatory | |
Gender | String | Optional | Must be 'M' or 'F' if provided | |
DayOfBirth | Integer | 2 | Mandatory | |
MonthOfBirth | Integer | 2 | Mandatory | |
YearOfBirth | Integer | 4 | Mandatory | |
HouseName | String | 26 | Mandatory if no HouseNumber given | Minimum 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 |
HouseNumber | String | 26 | Mandatory if no HouseName given | |
Flat | String | 20 | Optional | |
Street | String | 255 | Optional | |
Region | String | 255 | Optional | |
City | String | 100 | Optional | |
Postcode | String | 5 | Mandatory | |
Phone Number | String | 16 | Optional | Please provide the phone number as one contiguous set of numbers with no other characters or spaces. |
NationalId | String | 30 | Depends on country | |
NationalId Type (Global029NationalIdType Query option) | String | 30 | Depends 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.
Country | Code | Name | Address | Date of Birth | National ID | Phone Number |
---|---|---|---|---|---|---|
Argentina | ARG | Required | Optional | Recommended | Required | |
Australia | AUS | Required | Required | Required | Optional + Type | Optional |
Austria | AUT | Required | Required | Optional | ||
Bahrain | BHR | |||||
Belgium | BEL | Required | Recommended | Required | Optional | |
Brazil | BRA | Required | Recommended | Optional | Required | Recommended |
Canada | CAN | Required | Required | Optional | Optional | Recommended |
Chile | CHL | Required | Optional | Required | Required | |
China | CHN | Required | Optional | Recommended | Required | Recommended |
Colombia | COL | Required | Optional | Optional | Required | Optional |
Costa Rica | CRI | Required | Recommended | Recommended | Required | |
Czech Republic | CZE | Required | Required | Optional | ||
Denmark | DNK | Required | Required | Required | Required | Optional |
Egypt | EGY | |||||
Finland | FIN | Required | Required | Recommended | Required | Optional |
France | FRA | Required | Required | Recommended | Optional | |
Germany | DEU | Required | Required | Optional | Optional | |
Ghana | GHA | Required | Optional | Required + Type | Optional | |
Gibraltar | GIB | Required | Recommended | Optional | ||
Greece | GRC | Required | Recommended | Recommended | Optional | |
Guatemala | GTM | Required | Recommended | Recommended | Required | |
Hong Kong | HKG | Required | Optional | Required | Required | Optional |
India | IND | Required | Optional | Recommended | Required + Type | Recommended |
Indonesia | IDN | Required | Required | Required | Recommended | |
Ireland | IRL | Required | Required | Recommended | Optional | |
Italy | ITA | Required | Required | Required | Optional | Optional |
Jordan | JOR | |||||
Japan | JPN | Required | Required | Optional | ||
Kenya | KEN | Required | Optional | Required | Required + Type | Optional |
Kuwait | KWT | |||||
Lebanon | LBN | |||||
Luxembourg | LUX | Required | Required | Optional | ||
Malaysia | MYS | Required | Required | Required | Required | |
Mexico | MEX | Required | Optional | Recommended | Required | |
Netherlands | NLD | Required | Required | Required | Optional | |
New Zealand | NZL | Required | Required | Recommended | ||
Nigeria | NGA | Required | Recommended | Recommended | Required + Type | Recommended |
Norway | NOR | Required | Required | Recommended | Optional | Optional |
Peru | PER | Recommended | Recommended | Recommended | Required | |
Philippines | PHL | Required | Optional | Required | Required | Required |
Poland | POL | Required | Required | Recommended | Optional | Optional |
Portugal | PRT | Required | Required | Recommended | Optional | |
Romania | ROU | Required | Required | Required | Recommended | |
Russin Federation | RUS | |||||
Singapore | SGP | Required | Optional | Required | Required | |
Slovakia | SVK | Required | Required | |||
South Africa | ZAF | Required | Recommended | Optional | Required | Optional |
Spain | ESP | Required | Required | Recommended | Recommended | Optional |
Sweden | SWE | Required | Required | Required | Required | Optional |
Switzerland | CHE | Required | Required | Required | Optional | |
Thailand | THA | Required | Required | Required | Required | Recommended |
Turkey | TUR | Required | Required | Required | ||
United Arab Emirates | ARE | Required | Required | Optional | ||
United Kingdom | GBR | Required | Required | Optional | Optional | |
United States | USA | Required | Required | Recommended | Optional | Optional |
Vietnam | VNM | Required | Required | Optional | Required |
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:
Country | National ID Type | Global029NationalIdType query option (if needed) | Format Example | Total Characters (Including special characters) |
---|---|---|---|---|
Argentina | Documento Nacional de Identidad (DNI) | 10563145 | 8 | |
Australia | AU Passport | AUS-Passport | P0000000 | 8 or 9: 1 or 2 letters followed by 7 digits |
Australia | Foreign Passport | AUS-ForeignPassport | ||
Australia | Driver's License | AUS-DriversLicence | 1234567 | Varies by province/state |
Brazil | CPF | 000.000.000-00 | 14 | |
Brazil | CNPJ | 00.000.000/0001-00 | 18 | |
Canada | Social Insurance Number (SIN) | 123456789 | 9 | |
Chile | RUT / RUN numbers | XXXXXXXX-Z | 10 | |
China | Resident Identity Card Number | RRRRRRYYYYM MDDSSSC | 18 | |
Colombia | Colombian Personal Identification Number | 2131234321 | 8 or 10 digits | |
Costa Rica | Cedula de identidad number | 0 0000 0000 | 9 digits | |
Denmark | CPR | DDMMYY-0000 | 11 | |
Finland | Personal identity code | DDMMYYCZZZQ | 11 | |
Ghana | New Voter ID | GHA-NewVoterID | 0 | 10 |
Ghana | Passport | GHA-Passport | G0000000 | 8 |
Ghana | SSNIT | GHA-SSNIT | C000000000000 | 13 |
Ghana | Voter ID | GHA-VoterID | 0 | 10 |
Guatemala | Codigo Unico de Identification (CUI) | 0000 00000 0000 | 13 digits | |
Hong Kong | HKID | X123456(A) | 10 or 11 | |
India | PAN Number | IND-PANNumber | AAAPL1234C | 10 |
India | Voter ID (EPIC) | IND-VoterID | ABC0000000 | 10 |
India | Driver's License | IND-DriversLicence | HR- 0619850034761 OR HR06 19850034761 | 16 |
Indonesia | National ID (Nomor Induk Kependudukan) | XXXXXXDDMMY YXXXX | 16 | |
Italy | Codice Fiscale | SSSNNNYYMDD ZZZZX | 16 | |
Japan | "My number"/ Resident Record code | XXXXXXXXXXX | 11 | |
Jordan | Civil Identification Number | XXXXXXXXXXXX XX | 14 | |
Kenya | National ID | KEN-NationalID | 12345678 | 1 to 9 digits |
Kenya | Alien Card | KEN-AlienCard | 0 | 6 |
Kenya | Passport | KEN-Passport | 0 | 8 |
Kenya | National ID No Photo | KEN-NationalIDNoPhoto | 12345678 | 1 to 9 digits |
Kenya | KRA PIN | KEN-KRAPin | 12345678 | 1 to 9 digits |
Malaysia | NRIC | YYMMDD-SS- 123G | 14 | |
Mexico | CURP | HEGG560427MV ZRRL05 | 18 | |
Mexico | RFC | XXXXXXXXXXXX X | 13 | |
New Zealand | Driver's License | VV123456 | 8 | |
Nigeria | National Identification Number (NIN) | NGA-NIN | XXXXXXXXXXX | 11 |
Nigeria | Voter ID | NGA-VoterID | XXXX XXXX XXXX XXXX XXX | 19 |
Nigeria | Driver's License | NGA-DriversLicence | ABCXXXXXXXXX | 12 |
Nigeria | BVN | NGA-BVN | XXXXXXXXXXX | 11 |
Nigeria | Virtual National Identification Number (vNIN) | NGA-vNIN | AAXXXXXXXXXX XXXX | 16 |
Norway | National Identity Number | DDMMYYXXXXX | 11 | |
Peru | Documento Nacional de Identidad (DNI) | 1234567 | 8 | |
Philippines | PhilID Card Number (PCN) | 01234567891234 56 | 16 | |
Poland | PESEL number | YYMMDDZZZXQ | 11 | |
Romania | Cod Numeric Personal (CNP) | GYYMMDDZZSS SC | 13 | |
Singapore | NRIC | @xxxxxxx# | 9 | |
South Africa | National ID | YYMMDDSSSSC AZ | 13 | |
Spain | NIF/DNI | 00000000-A | 10 | |
Spain | NIE | X-0000000-A | 11 | |
Sweden | Personal Identification Number (PIN) | YYYYMMDD- NNGC | 13 | |
Thailand | Thai Identification Number (TIN) | 0-0000-0000-00-0 | 13 | |
Turkey | Turkish Identification Number | 11111111111 | 11 | |
United States | Social Security Number (SSN) | 123-45-6789 | 11 | |
Vietnam | National ID (NIN) | XXX G YY XXXXXX | 9 to 12 digits. 9 digits are older national IDs |
Example request
A typical request might look like this:
"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
"w2DataEkycGlobal029Result": {
"dataSources": [{
"AllowMultipleRecordsAsSeparateDataSources": false,
"MatchingCriteria": "NameAndAddress",
"NumberOfMatches": 1,
"Source": "Credit"
}
],
"interpretResult": "Pass",
"Message": "The call was successful",
"transactionResult": "SuccessIncompleteResults"
}
Multiple data sources example
"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
SourceId | Source Matched | Notes |
---|---|---|
8 | Credit | Data 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. |
9 | Government | A 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. |
10 | Commercial | Commercial 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. |
11 | Consumer | Consumer 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. |
12 | Utility | Data 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. |
13 | Proprietary | Data 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. |
14 | Teleco | Data 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. |
15 | Postal | Data 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
Property | Value |
---|---|
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 |
ServiceInterpretResult | - OneResult - MultipleResults - Fail - NoResults - NoInterpretPerformed - 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
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
{
"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