W2 Data EKYC AU 029
About the service
W2 Data EKYC AU 029 is an identity verification service for Australia. 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-AU-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 |
---|---|---|---|---|
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 | |
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 | Optional |
After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation returned for the service call.
Example Request
A typical request might look like this:
"Data": {
"City": "Kilmore",
"DayOfBirth": 1,
"Forename": "John",
"Gender": "M",
"HouseNumber": "1",
"MonthOfBirth": "10",
"Postcode": "1234",
"Region": "VIC",
"Street": "High Street",
"Surname": "Smith",
"YearOfBirth": 1980
}
Response
The following shows the basic schema for the W2DataEkyc029Result
object that is returned in the ServiceResult
Section of the ProcessRequestResult
object.
Example responses
Single data source
"w2DataEkycAU029Result": {
"dataSources": [{
"AllowMultipleRecordsAsSeparateDataSources": false,
"MatchingCriteria": "NameAndAddress",
"NumberOfMatches": 1,
"Source": "Credit"
}
],
"interpretResult": "Pass",
"Message": "The call was successful",
"transactionResult": "SuccessIncompleteResults"
}
Multiple data sources
"w2DataEkycAU029Result": {
"dataSources": [{
"AllowMultipleRecordsAsSeparateDataSources": false,
"MatchingCriteria": "NameAndAddress",
"NumberOfMatches": 1,
"Source": "Utility"
},
{
"AllowMultipleRecordsAsSeparateDataSources": true,
"MatchingCriteria": "NameAndAddressAndDateOfBirth",
"NumberOfMatches": 3,
"Source": "Credit"
}
],
"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>
elment.
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 occured, in which case the verification check will be aborted.
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 |
Sandbox
To use sandbox the following example request can be used.
Remember to include the W2 provided API key in the Authorization Header.
Example sandbox request
{
"Bundle": "KYC_AU_029",
"Data": {
"forename": "Cody",
"surname": "Rene",
"dayOfBirth": 12,
"monthOfBirth": 2,
"yearOfBirth": 1986,
"houseNumber": "73",
"street": "Moruya Street",
"postcode": "2484"
},
"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