Address Lookup

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 a 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

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

"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

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.

{
    "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:

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

The W2DataAddressLookup024Result will have 2 results and the corresponding ServiceTransactions will show the following properties:

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

The W2DataAddressLookup024Result will have 1 result and the corresponding ServiceTransactions will show the following properties:

If Postcode = "bs3 5an":

The W2DataAddressLookup024Result will have 3 results and the corresponding ServiceTransactions will show the following properties:

If AddressLookupRef = "W2AR0001-0001-0001-0007":

The W2DataAddressLookup024Result will have 1 result and the corresponding ServiceTransactions will show the following properties:

If Country = "USA" and Postcode = "20500-001:

The W2DataAddressLookup024Result will have 1 result and the corresponding ServiceTransactions will show the following properties: