W2 Data EKYC Lite US 005 Service

A lite identity check service for the USA

 

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 Optional  
MonthOfBirth
Integer
2 Optional  
YearOfBirth
Integer
4 Optional  
HouseName
String
26 Mandatory if no HouseNameNumber or HouseNumber given  
HouseNumber
String
26 Mandatory if no HouseNameNumber or 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.  

Request

The following is an example request:   

<QueryData>
<City>BURLESON</City>
<Forename>DARRELL</Forename>
<Gender>M</Gender>
<HouseNameNumber>2624</HouseNameNumber>
<PhoneNumber>8174473203</PhoneNumber>
<Postcode>76028</Postcode>
<Region>TX</Region>
<Street>CASTLE PINES DR</Street>
<Surname>BOEDEKER</Surname>
</QueryData>
   

Response

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

<W2DataEkycLiteUs005Result>
<DataSources>
<!-- An array of MatchingSource elements -->
<MatchingSource>
<AllowMultipleRecordsAsSeparateDataSources>
{ true | false }
</AllowMultipleRecordsAsSeparateDataSources>
<MatchingCriteria>
{
NameAndAddress | NameAndDateOfBirth |
NameAndAddressAndDateOfBirth | MortalityHighConfidence |
MortalityLowConfidence
}

</MatchingCriteria>
<NumberOfMatches>
{ 0 - 99 }
<NumberOfMatches>
<Source>
{
0 = NotAssigned
6 = MortalityData
8 = Credit
14 = Telephone
16 = SSN
17 = DrivingLicence
}

<Source>
</MatchingSource>
</DataSources>
<InterpretResult>
{
NotPerformed | Pass | Fail | Refer |
NotApplicable | NoInterpretPerformed
}

</InterpretResult>
<Message>
{ A message containing additional information about the call }
</Message>
<TransactionResult>
{
None | Success | SuccessNoResults | SuccessIncompleteResults |
MultipleChoices | ClientErrorInformationFormatInvalid | ClientErrorInsufficientInformation |
NotExecutedDueToPreviousHalt | ServerErrorGeneralError | ServiceFailureError
}

</TransactionResult>
</W2DataEkycLiteUs005Result>

Example Response:

The below example shows a case where we have found one NameAndAddress match.

 <W2DataEkycLiteUs005Result>
<DataSources>
<MatchingSource>
<AllowMultipleRecordsAsSeparateDataSources>false</AllowMultipleRecordsAsSeparateDataSources>
<MatchingCriteria>NameAndAddress</MatchingCriteria>
<NumberOfMatches>1</NumberOfMatches>
<Source>1</Source>
</MatchingSource>
</DataSources>
<InterpretResult>Pass</InterpretResult>
<Message>This call was generated using sandbox mode</Message>
<TransactionResult>Success</TransactionResult>
</W2DataEkycLiteUs005Result>

Transaction Result

HaltTriggered Usually false, but can be true if this service is used within a bundle that can trigger a halt condition.
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
  • Pass
  • Fail
  • Refer
  • 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 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.

<QueryOptions>
  <KeyValueOfstringstring>
    <Key>Sandbox</Key>
    <Value>true</Value>
  </KeyValueOfstringstring>
</QueryOptions>    

If the Sandbox query option is set to "true" then the following queries will return results. The result of the verification will depend on the configuration of the matching set up during the on-boarding process.  

Forename Surname Day Of Birth Month Of Birth Year Of Birth House Number Street City Region Postcode Personal Id Result
Angela Huggins 13 6 1970 3912 Atha Drive Bakersfield CA 93301   No Matches Found
Ashley Reinhardt 11 4 1971 2647 Lighthouse Drive Springfield MO 65806   1x Name & Address & DOB - Credit
Danielle Estrada 3 8 1990 2473 Pringle Drive Chicago IL 60605   1x Name & Address - Telco
David Bergeron 3 10 1993 1156 Sardis Station Golden Valley MN 55427 501113964 1x Name & Address & DOB - SSN
Eric Glenn 23 1 1974 1371 Eva Pearl Street Monticello LA 70814   1x  Name & Address - Credit
James Silvestre 24 1 1980 3443 Valley Street Salem NJ 08079   1x Name &Address - Driving License
Marie Hawks 2 7 1974 1139 Dogwood Road Phoenix AZ 85008   1x  Name & Address - Telco
Samuel Witt 20 10 1994 2893 Walton Street Salem UT 84653 254420123 1x  Name & Address - SSN
Sharen Holt 21 2 1968 2053 Rhapsody Street Gainesville FL 32607  

1x Name & Address - Credit

1x Name & Address & DOB - SSN

Timothy Mesa 21 9 1984 30111 Conifer Drive Seattle WA 98109   1x  Name & Address - Driving License