Skip to content
On this page

W2 Data Address Lookup 024

About the service

W2DataAddressLookup024Service 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.

Product Code: W2-DATA-ADDRESS_LOOK_UP-024

Does this service leave a credit search Footprint? No

Request

Query Data

The following properties pertain to this service.

Property NameTypeLengthOptional/MandatoryNotes
HouseNameString26Optional
HouseNumberString26Optional
PostcodeString8Mandatory
StreetString40Optional
CityString20Optional
CountryString3OptionalIf 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

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 service again and retrieve that specific address only at no cost. 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

Example Response

json
"w2DataAddressLookUp024Result": {
	"results": [{
			"addressLookupRef": "W2AR0001-0001-0001-0003",
			"addressSummary": "42 Some Street, Some Town, HU12 9FL",
			"buildingNumber": "42",
			"postTown": "Some Town",
			"postcode": "HU12 9FL",
			"thoroughfare": "Some Street"
		}
	]
}

Transaction Result

PropertyValue
HaltTriggeredFalse
ServiceTransactionResult- Success
- ClientErrorInsufficientInformationRequired field not supplied
ServiceInterpretResult- OneResult
- MultipleResults
- NoResults
- NotPerformed - An error occurred and the search was not performed
ServiceTransactionResultMessageUsually empty, can contain optional information such as too many matches etc.
ValidationResult- NotApplicable - No search occurred to match against-
FailMissingMandatoryField or PatternNotMatched

Sandbox

Example Request

To use sandbox the following example request can be used.

Remember to include the W2 provided API key in the Authorization Header.

json
{
    "Bundle": "KYC_ADDRESS_LOOKUP_024",
    "Data": {
        "Forename": "Michael",
        "Surname": "Tschank",
        "HouseNumber": "51",
        "Street": "Nobilegasse",
        "City":"Wien",
        "Postcode": "1150"
    },
    "Options": {
        "Sandbox": "true"
    },
    "ClientReference": "your-client-reference"
}

Sandbox Cases

If HouseNumber = "26" and Postcode = "LN4 7AT":
The W2DataAddressLookup024Result will be null and the corresponding ServiceTransactions will show the following properties:

PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccess
ServiceInterpretResultNoResults
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable
PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccess
ServiceInterpretResultMultipleResults
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable
PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccess
ServiceInterpretResultOneResult
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable
PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccess
ServiceInterpretResultMultipleResults
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable
PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccess
ServiceInterpretResultOneResult
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable
PropertyValue
HaltTriggeredFalse
ServiceTransactionResultSuccess
ServiceInterpretResultOneResult
ServiceTransactionResultMessage"This call was generated using sandbox mode"
ValidationResultNotApplicable