Skip to content
On this page

W2 DATA EKYC UK 007

Compatible Cases

About the service

This service has been deprecated.

W2_Data_Ekyc_Uk_007 Service is an identity verification service that includes the full Electoral Roll along with credit bureau data. This service will leave a money laundering footprint on the bureau 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

Request

Query Data

The following Query Data properties pertain to this service. Please note that in the SOAP request the fields should be in alphabetical order.

Property NameTypeLengthOptional/Mandatory
ForenameString30Mandatory
MiddleNamesString15Optional
SurnameString30Mandatory
DayOfBirthInteger2Mandatory
MonthOfBirthInteger2Mandatory
YearOfBirthInteger4Mandatory
HouseNameString26Optional *
HouseNumberString26Optional *
FlatString20Optional *
StreetString40Optional *
RegionString20Optional *
CountyString20Optional *
CountryString20Optional *
CityString20Optional *
PostcodeString8Optional *

After performing the search, the validation result (pass, fail, etc.) will be part of the <TransactionInformation> returned for the service call.

Notes

  • By default we include a check for Mortality Data. Users can turn this option off by adding the IncludeHaloMortalityCheck query option and setting it to false *Please note this setting is case sensitive, so something like includehalomortalitycheck (all lowercase) won't be picked up. *You can find information about the sandbox version of this service here.

Example Requests

Please note this is not actual data and shouldn't be used for testing and that these are not the only possible ways to query the service just some of the more common examples.

Example 1 - An example request for an identity check. Using a prematched address id.

json
{
    "Bundle": "{YOUR BUNDLE NAME HERE}",
    "Data": {
        "DayOfBirth": 22,
        "Forename": "Isabelle",
        "MonthOfBirth": 10,
        "Surname": "Davidson",
        "YearOfBirth": 1997        
    },
    "Options": {
        "AddressLookupRef": "12345"
    },
    "ClientReference": "{YOUR CLIENT REFERENCE HERE}"
}

Example 2 - An example request for an identity check. Using address information.

json
{
    "Bundle": "{YOUR BUNDLE NAME HERE}",
    "Data": {
    	"City": "Newport",
        "DayOfBirth": 22,
        "Forename": "Isabelle",
        "MonthOfBirth": 10,
        "Postcode": "WT1 1TD",
        "Surname": "Davidson",
        "YearOfBirth": 1997,
        "HouseNumber": "40",
        "MiddleNames":"Hope",
        "Street":"Awesome Street"
    },
    "ClientReference": "{YOUR CLIENT REFERENCE HERE}"
}

Example 3 - An example request for an identity check. Excluding the mortality data.

json
{
    "Bundle": "{YOUR BUNDLE NAME HERE}",
    "Data": {
        "DayOfBirth": 22,
        "Forename": "Isabelle",
        "MonthOfBirth": 10,
        "Surname": "Davidson",
        "YearOfBirth": 1997        
    },
    "Options": {
        "AddressLookupRef": "12345",
        "IncludeHaloMortalityCheck":"true"
    },
    "ClientReference": "{YOUR CLIENT REFERENCE HERE}"
}

Response

Example Responses

The responses below are just a few examples of possible responses there are other possible responses which may vary based on your particular bundle configuration but the examples below cover the main examples.

Example 1 - General Response

The first example below shows the general format of the response. Please note that any other service responses and the full SOAP envelope have been excluded for brevity.

json
{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "independentDataSources": true | false | null ,
                    "nameAndAddressMatch": true | false,
                    "nameAndDateOfBirthMatch": true | false
                },
                "matchResult": "NotChecked | TwoPlusTwo | TwoPlusOne | OnePlusOne | NoMatch"
            }
        }
    },
    "transaction": {
        "interpretResult": "Pass | Fail | Inconclusive | NotApplicable | NotPerformed",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": true | false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Pass | Fail | Inconclusive",
                "serviceTransactionResult": "Success",
                "serviceTransactionResultMessage": " Any information pertinent to this call",
                "validationResult": "Pass | Fail | Inconclusive | NoValidationPerformed | NotApplicable"
            }
        ]
    }
}

Example 2 - Successful Response

This example shows an example of a complete two plus two check, which would give a PASS.

json
{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "independentDataSources": true,
                    "nameAndAddressMatch": true,
                    "nameAndDateOfBirthMatch": true
                },
                "matchResult": "TwoPlusTwo"
            }
        }
    },
    "transaction": {
        "interpretResult": "Pass",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Pass",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }
}

Example 3 - Inconclusive Response

This example shows an inconclusive result where we have found both name and address and name and date of birth matches but not on different data sources.

json
{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "independentDataSources": false,
                    "nameAndAddressMatch": true,
                    "nameAndDateOfBirthMatch": true
                },
                "matchResult": "TwoPlusTwo"
            }
        }
    },
    "transaction": {
        "interpretResult": "Inconclusive",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Inconclusive",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }
}

Example 4 - Failing Response

This example shows a failing result where we have not found a match.

json
{
    "clientReference": "{YOUR CLIENT REFERENCE}",
    "results": {
        "w2DataEkycUk007Result": {
            "identityCheckResult": {
                "matchInformation": {
                    "nameAndAddressMatch": false,
                    "nameAndDateOfBirthMatch": false
                },
                "matchResult": "NoMatch"
            }
        }
    },
    "transaction": {
        "interpretResult": "Fail",
        "serviceCallReference": "{Call reference will be a new GUID here}",
        "serviceTransactions": [
            {
                "haltTriggered": false,
                "service": "W2DataEkycUk007",
                "serviceInterpretResult": "Fail",
                "serviceTransactionResult": "Success",
                "validationResult": "Pass"
            }
        ]
    }
}

Example 5 - Additional Information Response

By default we return an Identity Check Response detailed above, we can configure your account to also return some additional information that might further clarify the response. This would include an additional FullResponse element under the W2DataEkycUk007Result element as in the example below. To configure this response please contact W2 support.

json
"w2DataEkycUk007Result": {
	"fullResponse": {
		"mortalityData": [],
		"mortalityDataCheckType": "NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch",
		"uniqueAddressMatchFound": true | false,
		"verificationData": {
			"electoralRollNameAndAddressMatch": true | false,
			"electoralRollNameAndDateOfBirthMatch": "NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch",
			"lendersContributingToTheCreditFileCount": 0 - 99,
			"matchDateOfBirthUsingCreditRecords": "NotChecked | FullMatch | PartialMatch | NoMatch | MultipleMatch",
			"numberCcj": 0 - 99
		}
	},
	"identityCheckResult": {
		"matchInformation": {
			"independentDataSources": true | false | null,
			"nameAndAddressMatch": true | false,
			"nameAndDateOfBirthMatch": true | false
		},
		"matchResult": "NotChecked | TwoPlusTwo | TwoPlusOne | OnePlusOne | NoMatch"
	}
}

Sandbox

The Sandbox for the API can be used to generate fictitious responses that are pre-configured to display certain results. On this page is a complete list of the available Sandbox cases for the W2_DATA_EKYC_UK_007 service.

To use the Sandbox version of our API you need to set the Sandbox Query Option in the request to true. And query the service with any of the details below.

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