W2 DocsW2 Data EKYC US 005
Compatible Cases
About the service
W2 Data EKYC US 005 is an identity verification service for the USA. It uses Credit Reference Data, Telephone Directory, Passports and ID Card. This service will leave a credit lenders footprint.
Product Code: W2-DATA-EKYC-US-005
Does this service leave a credit search Footprint? Yes
Request
The following QueryData elements pertain to this service.
Query Data
| 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 | Optional | |
| MonthOfBirth | Integer | 2 | Optional | |
| YearOfBirth | Integer | 4 | Optional | |
| HouseName | String | 26 | Mandatory if no HouseNumber given | |
| HouseNumber | String | 10 | Mandatory if no HouseName given | |
| Street | String | 255 | Mandatory | |
| Region | String | 2 | Mandatory | Must be a USA state code in two letter format, e.g. "OH" |
| City | String | 100 | Mandatory | |
| Postcode | String | 5 | Mandatory | Must be five numeric digits |
| Phone Number | String | 16 | Optional | Please provide the phone number as one contiguous set of numbers with no other characters or spaces. |
| PersonalId | String | 11 | Optional | Personal ID is US Social Security Number and can be in any one of the three formats:'xxx-xx-xxxx' or 'xxx xx xxxx' or 'xxxxxxxxx' |
After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation returned for the service call.
Example Request
json
"Data": {
"City": "BURLESON",
"DayOfBirth": 15,
"Forename": "DARRELL",
"HouseNumber": "3782",
"MonthOfBirth": 2,
"Postcode": "35203",
"Region": "AL",
"Street": "Broad Street",
"Surname": "Ketron",
"YearOfBirth": 1977
}Response
Example Response
The following is an example of a typical response:
json
"w2DataEkycUs005Result": {
"creditReference": {
"creditReferenceRecords": {
"creditReferenceRecordList": [{
"addresses": {
"addressList": [{
"countryCode": "USA",
"postTown": "Birmingham",
"postcode": "35203",
"premise": "3782",
"region": "AL",
"street": "Broad Street"
}
]
},
"person": {
"dateOfBirth": "1977-02-15",
"name": {
"forename": "Cassie",
"surname": "Ketron"
}
}
}
]
},
"creditReferenceSummary": {
"idVerified": "1"
},
"summary": {
"decision": "1",
"decisionReasons": {
"decisionReasonList": [{
"decision": "1",
"element": "CreditReferenceSummary/IDVerified"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Person/Name/Forename"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Person/Name/Surname"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Person/DateOfBirth"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Addresses/Address/@Current"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Addresses/Address/Premise"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Addresses/Address/Street"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Addresses/Address/PostTown"
}, {
"decision": "1",
"element": "CreditReferenceRecord/Addresses/Address/Postcode"
}
]
}
}
},
"searchRef": "37873fcc-6281-4913-b6df-5f26497abfab",
"summary": {
"decisionMatrix": {
"code": "******",
"decision": {
"outcome": "1",
"reason": "Individual has a full match to forename surname premise postcode with ID verified and DOB"
},
"name": "****************",
"rules": {
"ruleList": [{
"id": "CreditReference Datablock",
"name": "BSO/USA/Bespoke/Nam/NameDOB",
"outcome": "1",
"reason": "Individual has a full match to forename surname and DOB"
}, {
"id": "Telephony Datablock",
"name": "BSO/USA/Bespoke/NamPremPC/ID/90/NameAddress",
"outcome": "1",
"reason": "Individual has a full match to forename surname premise postcode"
}
]
}
},
"kycSummary": {
"address": {
"count": "4"
},
"alerts": {
"count": "0"
},
"dateOfBirth": {
"count": "3"
},
"fullNameAndAddress": {
"count": "1"
},
"surnameAndAddress": {
"count": "0"
}
},
"reportSummary": {
"datablocksSummary": {
"datablockSummaryList": [{
"decision": "1",
"name": "CreditReference"
}, {
"decision": "1",
"name": "Telephony"
}
]
}
}
},
"telephony": {
"summary": {
"decision": "1",
"decisionReasons": {
"decisionReasonList": [{
"decision": "1",
"element": "TelephonyRecord/Person/Name/Forename"
}, {
"decision": "1",
"element": "TelephonyRecord/Person/Name/Surname"
}, {
"decision": "1",
"element": "TelephonyRecord/Address/Premise"
}, {
"decision": "1",
"element": "TelephonyRecord/Address/Postcode"
}
]
}
},
"telephonyRecord": {
"address": {
"countryCode": "USA",
"current": "1",
"postTown": "Birmingham",
"postcode": "35203",
"premise": "3782",
"region": "AL",
"street": "Broad Street"
},
"person": {
"name": {
"forename": "Cassie",
"surname": "Ketron"
}
},
"telephones": {
"telephoneList": [{
"customerType": "R",
"listingType": "DQ",
"number": "205-458-6981",
"type": "U"
}
]
}
},
"type": "Result"
}
}Response breakdown
The following tables give more detail about the various response elements:
| Property Name | Type | Description |
|---|---|---|
| SearchRef | String | Unique identifier for this search |
| Summary | Summary | Summary of information returned from various data sources |
| Telephony | TelephonyResult | Results of check from telephone records |
| DriverLicence | DriverLicenceResult | Results of check from driving licence records |
| Passport | PassportResult | Results of check from passport records |
| CreditReference | CreditReferenceResult | Results of credit check |
Summary
| Property Name | Type | Description |
|---|---|---|
| KYCSummary | KYCSummary | Summary of KYC result |
| ReportSummary | ReportSummary | Summary of individual source checks |
| DecisionMatrix | DecisionMatrix | Block containing 2 + 2 matching result |
KYCSummary
| Property Name | Type | Description |
|---|---|---|
| FullNameAndAddress | FullNameAndAddressKYCSummary | Count of name+address matches |
| SurnameAndAddress | SurnameAndAddressKYCSummary | Count of surname+address matches |
| Address | AddressKYCSummary | Count of address matches found |
| DateOfBirth | DateOfBirthKYCSummary | Count of date of birth matches |
| Alerts | AlertsKYCSummary | Count of alert matches found |
Report Summary
A report summary contains a few nested items that resemble the follwoing:
json
"reportSummary": {
"datablocksSummary": {
"datablockSummaryList": [{
"decision": "1",
"name": "CreditReference"
}, {
"decision": "1",
"name": "Telephony"
}
]
}
}Decision Matrix
Block containing 2 + 2 matching result.
json
"decisionMatrix": {
"code": "******",
"decision": {
"outcome": "1",
"reason": "Individual has a full match to forename surname premise postcode with ID verified and DOB"
},
"name": "****************",
"rules": {
"ruleList": [{
"id": "CreditReference Datablock",
"name": "BSO/USA/Bespoke/Nam/NameDOB",
"outcome": "1",
"reason": "Individual has a full match to forename surname and DOB"
}, {
"id": "Telephony Datablock",
"name": "BSO/USA/Bespoke/NamPremPC/ID/90/NameAddress",
"outcome": "1",
"reason": "Individual has a full match to forename surname premise postcode"
}
]
}
}Sandbox
Query options for Sandbox:
json
"options": {
"sandbox": "true"
}If the Sandbox query option is set to "true" then the following results can be achieved:
PASS
If the following details are set, a single fictitious match is returned in W2DataEkycUs005Result
| Property | Value |
|---|---|
| City: | "Birmingham" |
| DayOfBirth: | 15 |
| Forename: | "Cassie" |
| HouseNumber: | "3782" |
| MonthOfBirth: | 02 |
| Postcode: | "35203" |
| Region: | "AL" |
| Street: | "Broad Street" |
| Surname: | "Ketron" |
| YearOfBirth: | 1977 |
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceTransactionResult: | Success |
| ServiceInterpretResult: | Pass |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | NotApplicable |
FAIL
If the following details are set, a single fictitious match is returned in W2DataEkycUs005Result
| Property | Value |
|---|---|
| City: | "Pittsburgh" |
| DayOfBirth: | 18 |
| Forename: | "Erika" |
| HouseNumber: | "4200" |
| MonthOfBirth: | 07 |
| Postcode: | "15219" |
| Region: | "PA" |
| Street: | "Losh Lane" |
| Surname: | "Oneil" |
| YearOfBirth: | 1980 |
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceTransactionResult: | Success |
| ServiceInterpretResult: | Fail |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | Pass |
Otherwise a fictitious no-match is returned.
The corresponding entry in ServiceTransactions will show the following properties:
| Property | Value |
|---|---|
| HaltTriggered: | False |
| ServiceTransactionResult: | Success |
| ServiceInterpretResult: | NotApplicable |
| ServiceTransactionResultMessage: | "This call was generated using sandbox mode" |
| ValidationResult: | NotApplicable |