Address API

The Address API exposes the public Prontiq address endpoints generated from the committed OpenAPI spec. Use this page to choose the right endpoint and interpret the response fields that appear across multiple operations.

​

Which endpoint should I use?

​

Common response fields

​

Address identity

id is the G-NAF persistent identifier. Store it when a user selects a suggestion or validates an address, then pass it to Enrich when you need the complete address document. addressLabel, localityName, state, and postcode are the display fields most integrations use to populate forms. Enrich adds structured address components when available, including unit, level, lot, street number, street name, street type, site name, and building name. Prefer those fields over parsing addressLabel when your integration needs structured storage.

​

Prontiq match quality

Autocomplete and Validate return Prontiq-owned match-quality fields: prontiqMatchScore and prontiqMatchQuality. prontiqMatchScore estimates how well the returned address matched the submitted request. It is not a measure of G-NAF record quality, deliverability, or geocode precision. Score boundaries are stable for the address-match-v1 scorer:

​

G-NAF numeric confidence

Full address documents may include numeric confidence from G-NAF. It is source-record metadata about the address record, not a judgement about the user’s submitted query. G-NAF confidence values are: Autocomplete no longer returns G-NAF confidence. Use prontiqMatchScore and prontiqMatchQuality for request match quality. On Validate, match.confidence remains G-NAF source metadata. See Geoscape’s G-NAF documentation for the upstream data model: Data maintenance and Appendix C.

​

Debug diagnostics

All public Address endpoints accept debug=true. Debug responses are for support diagnostics only. debug.searchScore, when present, is an unstable internal search relevance score. Do not store it, sort by it, or use it for business decisions.

​

Geocode and location

geocode.latitude and geocode.longitude are decimal degrees. geocode.type describes the geocoding method when present. geocode.reliability is a G-NAF reliability value where lower is better. location is a compact latitude/longitude point with lat and lon.

​

Boundaries

boundaries contains administrative, electoral, and statistical geography when available: Boundary fields are optional because coverage varies by source record and data release. Enrich returns the richest boundary shape. In addition to the common boundary fields above, Enrich can include boundaries.sa1 for Statistical Area Level 1 joins and boundaries.ward for council ward context when available.

​

Lookup counts and bounds

Postcode lookup returns address_count for each locality in the postcode. Suburb lookup returns total address_count, postcodes, and optional bounds. When suburb lookup is called without state, matching localities across states may be aggregated.

​

API reference

The API Reference pages render request parameters, response schemas, errors, and the Mintlify playground from packages/docs/openapi.json.