W2DataEkycUk007B
About the service
W2 Data Ekyc UK 007B is an identity verification service that includes the full Electoral Roll, CCJ and Credit Lenders data. This service will leave a money laundering footprint on the lenders profile of the person you are requesting information about.
Product Code: W2-DATA-EKYC-UK-007
Does this service leave a credit search Footprint? Yes
Configuration
This service has some configuration that will be discussed with you as part of the on-boarding process. We can configure a matching profile and which sources of information to use when calculating a 2 plus 2 check. Please contact W2 Support for more information.
Request
Query Data
The following Query Data properties pertain to this service. Please note that in the SOAP request the fields must be in alphabetical order.
Property Name | Type | Min Length | Max Length | Optional/Mandatory | Accepted Characters |
---|---|---|---|---|---|
Forename | String | 1 | 30 | Mandatory | All apart from (new line ' - \ \\ ,) |
MiddleNames | String | 15 | Optional | All apart from (new line ' - \ \\ ,) | |
Surname | String | 1 | 30 | Mandatory | All apart from (new line ' - \ \\ ,) |
DayOfBirth | Integer | 1 | 2 | Mandatory | Numbers Only - greater than 0 |
MonthOfBirth | Integer | 1 | 2 | Mandatory | Numbers Only - greater than 0 |
YearOfBirth | Integer | 1 | 4 | Mandatory | Numbers Only - greater than 0 |
HouseName | String | 26 | Optional | Either house name or house number must be supplied | |
HouseNumber | String | 26 | Optional | Either house name or house number must be supplied | |
Flat | String | 20 | Optional | ||
Street | String | 32 | Optional | ||
Region | String | 20 | Optional | ||
County | String | 18 | Optional | ||
Country | String | 20 | Optional | ||
City | String | 28 | Optional | ||
Postcode | String | 1 | 8 | Mandatory |
After performing the search, the validation result (pass, fail, etc.) will be part of the TransactionInformation
returned for the service call.
Notes
Address information is optional if an AddressLookupRef is supplied in the query options. The AddressLookupRef is retrieved from the W2 Data Address Lookup 024 service as an addressId.
If an AddressLookupRef is not supplied then a minimum of House Name/Number and Postcode are required. Though it is advised to supply as much address information as possible as this is more likely to return a match if no prematched addressId is supplied.
Example Request
{
"Bundle": "YOURBUNDLE",
"Data": {
"DayOfBirth": 22,
"Forename": "Isabelle",
"MonthOfBirth": 10,
"Surname": "Davidson",
"YearOfBirth": 1997
},
"Options":{
"AddressLookupRef":"12345"
}
}
Response
Example Response
"w2DataEkycUk007BResult": {
"dataSources": [{
"AllowMultipleRecordsAsSeparateDataSources": false,
"MatchingCriteria": "NameAndAddressAndDateOfBirth",
"NumberOfMatches": 2,
"Source": "CreditLendersB"
}
],
"interpretResult": "Pass",
"Message": "The call was successful",
"transactionResult": "SuccessIncompleteResults"
}
Example Response 2
The example shows a case where we have found one NameAndAddress match on the Electoral roll and 3 NameAndAddressAndDateOfBirth matches on CreditLendersB. This has resulted in a Pass.
"w2DataEkycUk007BResult": {
"dataSources": [{
"AllowMultipleRecordsAsSeparateDataSources": false,
"MatchingCriteria": "NameAndAddress",
"NumberOfMatches": 1,
"Source": "ElectoralRoll"
},
{
"AllowMultipleRecordsAsSeparateDataSources": true,
"MatchingCriteria": "NameAndAddressAndDateOfBirth",
"NumberOfMatches": 3,
"Source": "CreditLendersB"
}
],
"interpretResult": "Pass",
"Message": "The call was successful",
"transactionResult": "SuccessIncompleteResults"
}
Response breakdown
The following shows the basic schema for the W2DataEkycUk007BResult
result.
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. 2 = CCJ (County Court Judgement)
SourceId | Source Matched |
---|---|
1 | Electoral Roll |
2 | County Court Judgements (CCJs) |
3 | N/A |
4 | Credit Lenders (Insight) |
5 | BT_OSIS |
6 | Mortality Data |
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 | 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 |
Warnings
A warning occurs when a verified response returns an address variant that is different to the request that was sent.
This will now display several warning messages that identify the verified response, the supplied response and where this differs.
Below are the properties that will display if any address variance occurs, then these will be displayed :
Property Name | Type |
---|---|
HouseName | String |
HouseNumber | Integer |
Street | String |
Postcode | String |
Flat | String |
Example of a Warning Response
{
"clientReference": "REST API Client Wrapper Testing",
"results": {
"w2DataEkycUk007BResult": {
"characteristics": [],
"warnings": [
{
"message": "Address variance found in the HouseName response - this individual was verified using HouseName: The House; HouseName supplied in request: TheHouse;"
},
{
"message": "Address variance found in the HouseNumber response - this individual was verified using HouseNumber: 23; HouseNumber supplied in request: 22;"
},
{
"message": "Address variance found in the Street response - this individual was verified using Street: OceansView; Street supplied in request: Ocean View;"
},
{
"message": "Address variance found in the Postcode response - this individual was verified using Postcode: WT1 1TA; Postcode supplied in request: WT1 1TD;"
},
{
"message": "Address variance found in the Flat response - this individual was verified using Flat: 2; Flat supplied in request: 254;"
}
],
"dataSources": [],
"encodedScore": "13110",
"interpretResult": "Pass",
"message": "Matching performed using 3,1,1,2,4 sources as per profile",
"transactionResult": "Success"
}
},
"transaction": {
"interpretResult": "Pass",
"serviceCallReference": "9be156fe-c0ef-44bd-9aeb-ccdc5957deed",
"serviceTransactions": [
{
"haltTriggered": false,
"service": "W2_DATA_EKYC_UK_007_B",
"serviceInterpretResult": "Pass",
"serviceTransactionResult": "Success",
"serviceTransactionResultMessage": "Matching performed using 3,1,1,2,4 sources as per profile",
"validationResult": "Pass"
}
]
}
}
Sandbox
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.
Example Request
{
"Bundle": "KYC_UK_007B",
"Data": {
"Forename": "Abbie",
"Surname": "Forster",
"DayOfBirth": 26,
"MonthOfBirth": 12,
"YearOfBirth": 1962,
"HouseNumber": "241",
"Street": "Ocean View",
"Postcode": "WT1 1TD"
},
"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