Address Validate API
/address_validate
Tests a supplied address against the GNAF database and returns a quality score from 0 to 10, plus the matched address with any corrections applied. The validator will fix minor mistakes (spelling errors in the street or suburb, the wrong street type, a postcode that's one off) so long as the rest of the address is still resolvable. You get the corrected address back along with a list of every change that was made.
Example Request
POSTRequest Schema
street_address
First line of the address. Requires at least one of suburb or postcode.
suburb
Suburb name. Requires street_address.
state
ACT, NSW, NT, QLD, SA, TAS, VIC, WA. Requires street_address.
postcode
Postcode. Requires street_address.
suburb_state_postcode
Combined suburb, state and postcode. Requires street_address.
full_address
Full address as a single string. Use this when you don't have the components separated.
Available Response Data
5 Data Pointsvalid
boolean indicating whether the address could be matched
score
0 to 10 indicating match quality. Calculated as 10 - number of address changes minimum 0. Null if invalid.
matched_address
the resolved address with address_id GNAF, full_address, address_line_1, address_line_2, suburb, state, postcode, plus parsed components: unit_type, unit_number_prefix, unit_number, unit_number_suffix, level_type, level_number_prefix, level_number, level_number_suffix, street_number_1_prefix, street_number_1, street_number_1_suffix, street_number_2_prefix, street_number_2, street_number_2_suffix, lot_number_prefix, lot_number, lot_number_suffix, postal_delivery_type, postal_delivery_number_prefix, postal_delivery_number, postal_delivery_number_suffix, street_name, street_type, street_suffix
address_changes
array of changes made to the supplied address. Each entry has field and change e.g. "Changed from ST to PL"
api_reference for log tracing
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Technical Use Cases tag
Form-level validation at submit time
Run a validation pass when a customer submits an address. Surface the corrected address back to them for confirmation if changes were made, which catches typos before they get baked into your customer record.
Bulk database cleansing
Run customer addresses through validation as part of a periodic data hygiene job. Update records where the validator returns a corrected address.
Score-based routing
A score of 10 is a clean pass-through. Scores 7 to 9 typically indicate minor corrections worth showing to the customer. Below 5 is worth a human review. Build your routing logic on the score.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
What kinds of corrections does the validator make?
add
What kinds of corrections does the validator make?
What kinds of corrections does the validator make? | answer: Spelling fixes to street and suburb names, changes to the street type (Rd vs St vs Pl), changes to the unit type (Flat to Unit), postcode corrections to an adjacent postcode, suburb changes to an adjacent suburb, and street number range corrections (e.g. “123 Smith St” matching “123-125 Smith St”). Anything more than that and the address comes back invalid.
rocket_launch Implementation
How is the score calculated?
add
How is the score calculated?
Starts at 10 and drops by 1 for each change made to the supplied address. Minimum is 0. So a perfect pass-through with no changes gets 10. One spelling correction gets 9. A spelling fix plus a postcode correction gets 8. And so on.
rocket_launch Implementation
Can I send just full_address and skip the components?
add
Can I send just full_address and skip the components?
Yes. full_address on its own is one of the three valid input modes. The validator will parse it and resolve to GNAF. Useful when you’ve captured the address as free text without component parsing.
API Testing Sandbox tag
Test the Address Validate API directly in your browser with live mock data and see instant results.
rocket_launch Request Sandbox AccessAccess to live sandbox environments requires manual approval from our compliance team.