Address v1
These methods have been deprecated.
We recommend you upgrade your service to the latest Address Validation method. Upgrade at no cost and improved performance.
Address lookup methods (AU/NZ)
Address lookup methods take complete or partial address information as an input and perform a search against an address Source of Truth, returning address information that matches the search parameters.
address
Lookup addresses using a single-line input address. If want to further filter the result by the locality level information, you can also specify the locality, postcode or state value
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
fullAddress
attribute is required
Request Parameters (GET)
The
fullAddress
attribute is requiredThe
sourceOfTruth
attribute is requiredThe
locality
attribute is optionalThe
postcode
attribute is optionalThe
state
attribute is optionalThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
buildingName
Performs a search for building names using the supplied buildingName
.
Additional information supplied in the request will further filter the results.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
buildingName
attribute is requiredThe
postcode
attribute is optionalThe
locality
attribute is optionalThe
townCity
attribute is optional (New Zealand)The
suburb
attribute is optional (New Zealand)The
street
attribute is optionalThe
streetNumber
attribute is optionalThe
featureOptions
attribute is optional
Request Parameters (GET)
The
buildingName
attribute is requiredThe
sourceOfTruth
attribute is requiredThe
postcode
attribute is optionalThe
locality
attribute is optionalThe
transactionID
attribute is optional
Response
The response body is an AddressRestResponse object:
locality
Performs an Australian locality search using the supplied information.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
locality
attribute is required for non-semi locality searchThe
postcode
attribute is optionalThe
fullAddress
attribute is required for semi locality search
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
locality
attribute is required for non-semi locality searchThe
postcode
attribute is optionalThe
fullAddress
attribute is required for semi locality searchThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
postal
Performs a search for a postal address using the supplied information.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
postal
is requiredEither the
postcode
orlocality
attribute is required
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
postal
is requiredEither the
postcode
orlocality
attribute is requiredThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
postcode
Performs a postcode search using the supplied information.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
postcode
attribute is required
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
postcode
attribute is requiredThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
street
Performs a street search using the supplied information.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
street
attribute is requiredThe
postcode
attribute is optionalThe
locality
attribute is optionalThe
townCity
attribute is optional (New Zealand)The
suburb
attribute is optional (New Zealand)
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
street
attribute is requiredThe
postcode
attribute is optionalThe
locality
attribute is optionalThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
streetNumber
Performs a street number search using the supplied information.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
streetNumber
attribute is requiredThe
postcode
attribute is requiredThe
locality
attribute is requiredThe
townCity
attribute is optional (New Zealand)The
suburb
attribute is optional (New Zealand)The
street
attribute is required
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
streetNumber
attribute is requiredThe
postcode
attribute is requiredThe
locality
attribute is requiredThe
street
attribute is requiredThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
subdwelling
Performs a subdwelling search using the supplied information.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
subdwelling
attribute is requiredThe
postcode
attribute is optionalThe
locality
attribute is optionalThe
townCity
attribute is optional (New Zealand)The
suburb
attribute is optional (New Zealand)The
street
attribute is optionalThe
streetNumber
attribute is optional
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
subdwelling
attribute is requiredThe
postcode
attribute is requiredThe
locality
attribute is requiredThe
street
attribute is requiredThe
streetNumber
attribute is requiredThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
subdwellingAddress
List all subdwellings under a given address.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
id
attribute is required
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
id
attribute is requiredThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
suburb
Performs a New Zealand Suburb search using the supplied information.
The suburb method is only valid when the 'NZPAF' or 'NZAD' sourceOfTruth parameter is supplied.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
suburb
attribute is requiredThe
postcode
attribute is optionalThe
townCity
attribute is optional
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
suburb
attribute is requiredThe
postcode
attribute is optionalThe
townCity
attribute is optionalThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
townCity
Performs a lookup for Towns and Cities in New Zealand using the supplied information.
The townCity method is only valid when the 'NZPAF' or 'NZAD' sourceOfTruth parameter is supplied.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
The
townCity
attribute is requiredThe
postcode
attribute is optional
Request Parameters (GET)
The
sourceOfTruth
attribute is requiredThe
townCity
attribute is requiredThe
postcode
attribute is optionalThe
transactionID
attribute is optionalThe
featureOptions
attribute is optional
Response
The response body is an AddressRestResponse object:
AUNZreverseGeocode
Lookup addresses through the specified Source of Truth within a certain distance using the geocode input.
For multiple geocode inputs, only the first record will be processed. The supported Source of Truths are 'GNAF', 'NZPAF', 'NZAD' and 'CNAR' (default is GNAF for Australia and NZPAF for New Zealand).
Resource URL
Request
The request body is an AddressRestRequest object:
The
attributes
withlatitude
andlongitude
is requiredThe
sourceOfTruth
is optional. The supported Source of Truths are GNAF, NZPAF, NZAD, CNAR (default is GNAF for Australia and NZPAF for New Zealand).The
featureOptions
is optional. The supported feature options are displayGnafLot, singleLineHitNumber (default 20), caseType, exposeAttributes, radius (default 50 for 50 meters radius).
Response
The response body is an AddressRestResponse object:
transaction
Indicates that an address lookup transaction has been completed.
The transaction method must be called when address has been found using the lookup process. It is used for audit and billing purposes.
Resource URL
Or if using GET
Request (POST)
The request body is an AddressRestRequest object:
Request Parameters (GET)
The
sourceOfTruth
attribute is required
Response
The response body is an AddressRestResponse object:
Last updated