Address Verification API

The Address Verification API takes an address (potentially containing spelling mistakes and/or other errors) and attempts to match it against a valid address record in the Addressfinder database. This API can verify your addresses against either Australia Post's PAF, Geoscape's GNAF or both.

Endpoint

Australia

https://api.addressfinder.io/api/au/address/v2/verification

Parameters

Parameter	Default	Description
`key`		Your unique licence key (find on Portal credentials) Required string
`secret`		Your unique secret key (find on Portal credentials). This required when calling API endpoints without a referer. Optional string
`format`	`json`	The required format of the response. Optional string
`q`		The address to be verified. Optional string
`gnaf`	`1`	Returns physical addresses from the GNAF database. One or both of GNAF or PAF databases need to be selected. `1` - Queries the GNAF database Optional string
`paf`	`1`	Returns postal addresses from the PAF database. One or both of GNAF or PAF databases need to be selected. `1` - queries the AU PAF database Optional string
`post_box`		Box type addresses are included by default (only available from PAF database). Use this attribute to exclude them. `0` - Excludes Box type addresses from the verification results. Optional string
`gps`		Returns gps coordinates from the datasource specified (when available). `1` - Returns latitude and longitude. Optional string
`extended`		Returns `lga_name`, `lga_type_code`, `gnaf_id` and `legal_parcel_id` from the GNAF database. `1` - Returns additional data available from GNAF. Optional string
`census`		Returns statistical area identifiers (Meshblock, SA1 & SA2) from the specified census year. These attributes are only available from the GNAF database and are not returned if census is omitted. Optional integer
`state_codes`		Filter the results according to the states or territories. Use a comma to separate multiple values: `ACT` - Only returns addresses from Australian Capital Territory `NSW` - Only returns addresses from New South Wales `NT` - Only returns addresses from Northern Territory `QLD` - Only returns addresses from Queensland `SA` - Only returns addresses from South Australia `TAS` - Only returns addresses from Tasmania `VIC` - Only returns addresses from Victoria `WA` - Only returns addresses from Western Australia `OT` - Only returns addresses from Other Territories Optional string
`domain`		Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. Optional string
`ascii`		Set to `1` to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. Pōneke and Café will be returned as Poneke and Cafe). Optional string

Responses

200 OK

Name	Type	Description	Example
`matched`	boolean	Indicates if the address has been matched or not.	true
`success`	boolean	Indicates if the request was successful or not.	true
`address`	object	description text	-
`id`	string	The unique address identifier. This ID will change following a data refresh.	73e8268c-bd5c-57a0-c20c-bcce334fe361
`full_address`	string	Full address string.	274 Harbour Drive, COFFS HARBOUR NSW 2450
`address_line_1`	string	First line of the non-locality/state/postcode portion of the address.	274 Harbour Drive
`address_line_2`	string	Second line of the non-locality/state/postcode portion of the address. This will be null for addresses without a unit/level/etc number.	-
`address_line_combined`	string	A combination of the first and second lines of the non-locality/state/postcode portion of the address.	274 Harbour Drive
`locality_name`	string	The locality/suburb of this address.	COFFS HARBOUR
`state_territory`	string	The Australian state or territory where the address is located.	NSW
`postcode`	string	Box type addresses are included by default (only available from PAF database). Use this attribute to exclude them.	2450
`latitude`	string	Latitude coordinate (in WGS84 format).	-30.304978
`longitude`	string	Longitude coordinate (in WGS84 format).	153.126321
`box_identifier`	string	Identifies a specific box. Can be an alpha, number or a combination.	-
`box_type`	string	Describes the type of box.	-
`street_number_1`	string	The number of the building on the street.	274
`street_number_2`	string	Holds the upper bound when this is a ranged address. For single number addresses this field is `null`	-
`unit_identifier`	string	Identifies a specific sub-dwelling. Can be an alpha, number or a combination.	-
`unit_type`	string	Describes the category of a sub-dwelling.	-
`level_number`	string	Identifies a specific level within a multi-level building. Can be an alpha, number or a combination.	-
`level_type`	string	Describes the level type within a multi-level building.	-
`lot_identifier`	string	Identifies a specific lot on a site. Can be an alpha, number or a combination.	CP
`site_name`	string	Holds the address element that identifies the name of a site or building.	-
`street_name`	string	Holds the name of the street.	Harbour
`street_type`	string	The type of street.	Drive
`street_suffix`	string	The suffix of the street. Typically contains a compass direction.	-
`street`	string	Holds the full name of the street.	Harbour Drive
`meshblock`	string	The meshblock identifier in which the address is located.	-
`sa1_id`	string	The statistical area (SA1) identifier in which the address is located.	-
`sa2_id`	string	The statistical area (SA2) identifier in which the address is located.	-
`lga_name`	string	The name of the Local Government Area in which the address is located.	Harbour
`lga_type_code`	string	The code relating to the type (or status) of the Local Government Area.	Drive
`gnaf_id`	string	The unique persistent identifier of the G-NAF address.	-
`legal_parcel_id`	string	Government legal property description.	-

400 Bad request

Name	Type	Description	Example
`completions`	array	An empty array will be returned due to the error	-
`error_code`	string	A unique numerical value identifying the error that occured	1004
`message`	string	An informative message describing the error that occured	Secret not provided
`success`	boolean	Indicates that the result was a failure	false

See API Error Reference for details.