NZPost.AddressChecker

(5 reviews)

Partial Address Details

Resource URL

UAT:

http://api.uat.nzpost.co.nz/addresschecker/1.0/partial_details
Production:
https://api.nzpost.co.nz/addresschecker/1.0/partial_details

Resource Description

Takes a partial's unique_id and returns detailed information about the matching partial address.

Resource Information

Attribute Detail
Response Format JSON
Requires Authentication Yes
Rate Limited 15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out.

Please note that all request parameters should be in lower case.

Request Parameters

Field Name Description Value Required Example
unique_id The unique identifier of the partial address. String Yes 89178

Sample Request

https://api.nzpost.co.nz/addresschecker/1.0/partial_details?unique_id=89178

Response Parameters

Field Name Description Value Required Example
success Indicates if the request succeeded or not. Boolean Yes true
details Details of the requested address. Array Yes if success = true See Details Object below

Details Object

Field Name Description Value Example
UniqueId The unique identifier of the partial address. Integer 89178
NZGD2kCoord Contains coordinate information for a point. Contains the following keys:
  • "type"
  • "crs"
  • "coordinates"
Geo JSON Point See Sample Response below
NZGD2kBBOX Contains coordinate information for a polygon. Contains the following keys:
  • "type"
  • "crs"
  • "coordinates"
GeoJSON Polygon See Sample Response below
RoadName Street name. The name of the street / road, including prefix. String Willis
RoadTypeName Street type String Street
RoadSuffixName Street direction. Directional suffix details after Road. String e.g. "West"
SuburbName Suburb name String Te Aro
CityTown The name of the town or city. String Wellington
Postcode NZ Post code used for defining an area. String 6011
FullPartial Full partial address that might include suburb, town, city, postcode. String Willis Street, Te Aro, Wellington 6011
BoxBagPostcode Boolean false

Sample Response

resources/partial_detail1-d7ad259d-e7e8-4725-93d5-1962395d29ed.PNG
resources/partial_detail2-30d00c38-5a32-47f6-a758-7e79c3fe721f.PNG


Reviews