Address Validate API
/address_validate
Tests the supplied address and returns the matched address and a score from 0 to 10 indicating the quality of the match.
Example Request
POST{
"street_address": "Unit 12B, 123-125 Smith St",
"suburb": "Smithtown",
"state": "ACT",
"postcode": "2000",
"suburb_state_postcode": "Smithtown ACT 2000",
"full_address": "Unit 12B, 123-125, Smithtown, ACT 2000"
}
Available Response Data
Request Schema
| Field Name | Type | Required | Description |
|---|---|---|---|
| street_address | string | No | First line of the street or postal address. Requires suburb or postcode. |
| suburb | string | No | Suburb name. Requires street_address. |
| state | string | No | State abbreviation. Requires street_address. |
| postcode | string | No | Postcode. Requires street_address. |
| suburb_state_postcode | string | No | Combined suburb, state and postcode. Requires street_address. |
Technical Use Cases
Fraud Prevention
Ensure a submitted address physically exists and is formatted correctly before processing high-risk financial transactions.
Logistics & Delivery
Automatically correct misspelt street names (ST to PL) to prevent expensive returned mail and delivery failures.
Webhooks & Events
address-validation-flagged
Trigger custom internal workflows if an address score drops below your required threshold.
Compliance & Security
Common Questions
Everything you need to know about implementation details and compliance infrastructure.
help_center General
What does the match score mean?
add
What does the match score mean?
The score ranges from 0 to 10. A 10 means a perfect, exact match. Lower scores indicate the API had to make assumptions or corrections (detailed in the address_changes array) to find a valid match.