GET v3/postcode-lookup/{postcodeLookupId}

Returns address information for a specific postcode id

Request Information

URI Parameters

Name	Description	Type	Additional information
postcodeLookupId		string	Required

Body Parameters

None.

Response Information

Resource Description

Address

Name	Type	Additional information
Country	Country	None.
AdministrativeDivision	AdministrativeDivision	None.
Name	string	None.
Line1	string	None.
Line2	string	None.
Line3	string	None.
Line4	string	None.
Line5	string	None.
Postcode	string	None.
Town	string	None.

Response Formats

application/json

Sample:

{
  "country": {
    "isoCode": "",
    "name": "",
    "postcodeRequired": false
  },
  "administrativeDivision": {
    "name": "",
    "isoCode": null
  },
  "name": "sample string 1",
  "line1": "sample string 2",
  "line2": "sample string 3",
  "line3": "sample string 4",
  "line4": "sample string 5",
  "line5": "sample string 6",
  "postcode": "sample string 7",
  "town": "sample string 8"
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.