Merchants
Address Lookup
To ensure the appropriate formatting of an address is included as part of a UK merchant boarding application, you can use Address Lookup to perform a search on all addresses with a certain house number or house name within a postal code.
Authorization
bearerAuth AuthorizationBearer <token>
Access token from POST /accesstoken, sent as Authorization: Bearer <token>.
In: header
Query Parameters
postal_code*string
The postal code of the address.
Length
1 <= length <= 255building_number?string
UK only. The number associated with the address home/building.
building_name?string
UK only. The number associated with the address home/building.
Header Parameters
X-GP-Version*string
The version of the API to execute the request.
Length
1 <= length <= 50Default
"2021-03-22"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/addresses?postal_code=CB6+1AS" \ -H "X-GP-Version: 2021-03-22"{ "addresses": [ { "reference": "12535421321", "building_name": "Rose Cottage", "building_number": "1001", "line_1": "Merchant Street", "line_2": "Suite 2", "line_3": "Harrow", "city": "Ely", "state": "CAMBS", "country": "GB", "postal_code": "CB6 1AS" } ], "action": { "id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "time_created": "2021-05-03T21:23:39.718Z", "type": "ADDRESS_LIST", "result_code": "SUCCESS", "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d", "app_name": "my_lovely_app" }}