W2 Data Address Lookup 007 Service

W2 Data Address Lookup 007 Service

W2DataAddressLookup007Service is an address verification service. It provides a fully-formed address where partial details are provided. If there are multiple possible matches, it provides the list of them, up to a limit of 100.

Properties

The following properties pertain to this service.

Property Name Type Length Optional/Mandatory Notes
HouseNameNumber
String
26 Mandatory if no HouseName or HouseNumber given  
HouseName
String
26 Mandatory if no HouseNameNumber or HouseNumber given  
HouseNumber
String
26 Mandatory if no HouseNameNumber or HouseName given  
Postcode
String
8 Mandatory  
Street
String
40 Optional  
County
String
20 Optional  
City
String
20 Optional  
Country
String
3 Optional If set, must be a valid three-letter ISO country code as described here. If not set, the search will be within the United Kingdom (GBR)

Notes

  1. Usually this service is part of a larger bundle and appears toward the start of the workflow.

    Each address match will have an AddressId element. You can use this address code to call the W2_Data_Ekyc_Uk_007 Service again and retrieve that specific address only. To do this add a QueryOptions property with key AddressLookupRef and with the address code as the value.

    If this QueryOptions parameter is provided the above QueryData will be ignored.

Response

The following is an example response:

<W2DataAddressLookUp007Result>
 <!-- One or more of these -->
 <AddressMatches>
	<AddressMatch>
	   <AddressId>TEST0004494</AddressId>
	   <Country />
	   <County>ISLE OF SKYE</County>
	   <District />
	   <HouseName />
	   <HouseNumber>FLAT 3</HouseNumber>
	   <PoBox />
	   <PostCode>IV448TZ</PostCode>
	   <PostTown>TRAINING TOWN</PostTown>
	   <Street1>HEATHFIELD HOUSE</Street1>
	   <Street2>ROWLANDS CLOSE</Street2>
	   <SubBuilding />
	</AddressMatch>
 </AddressMatches>
 <MatchType>MultipleMatch</MatchType>
</W2DataAddressLookUp007Result>

Sandbox

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

If the Sandbox query option is set to "true" the following entry will be returned in the ServiceResult: 

If HouseNameNumber = "68" and Postcode = "RH13 3HE":

The W2DataAddressLookup007Result will be null, the AddressMatchType will be NoMatch and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult NoResults
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If HouseNameNumber = "26" and Postcode = "LN4 7AT":

The W2DataAddressLookup007Result will have 2 results, the AddressMatchType will be MultipleMatch and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult MultipleResults
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If HouseNameNumber = "42" and Postcode = "hu12 9fl":

The W2DataAddressLookup007Result will have 1 result, the AddressMatchType will be FullMatch and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult OneResult
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable

If HouseNameNumber = "30" and Postcode = "bs3 1hn":

The W2DataAddressLookup007Result will have 3 results, the AddressMatchType will be PartialMatch and the corresponding ServiceTransactions will show the following properties:

HaltTriggered False
ServiceTransactionResult Success
ServiceInterpretResult MultipleResults
ServiceTransactionResultMessage "This call was generated using sandbox mode"
ValidationResult NotApplicable