Enrich - prontiq

GET

https://api.prontiq.dev

address

enrich

Enrich an address by ID

curl --request GET \
  --url https://api.prontiq.dev/v1/address/enrich \
  --header 'X-Api-Key: <api-key>'

const url = 'https://api.prontiq.dev/v1/address/enrich';
const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.prontiq.dev/v1/address/enrich"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.get("https://api.prontiq.dev/v1/address/enrich")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prontiq.dev/v1/address/enrich"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prontiq.dev/v1/address/enrich")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "GAQLD156786950",
  "addressLabel": "9 ENDEAVOUR COURT",
  "localityName": "LAMMERMOOR",
  "state": "QLD",
  "postcode": "4703",
  "confidence": 2,
  "geocode": {
    "latitude": -23.1601,
    "longitude": 150.7596,
    "type": "PROPERTY CENTROID",
    "reliability": 2
  },
  "location": {
    "lat": -23.1601,
    "lon": 150.7596
  },
  "boundaries": {
    "lga": {
      "name": "Glen Eira",
      "code": "lga9bd137c30d17"
    },
    "stateElectorate": {
      "name": "Keppel"
    },
    "commonwealthElectorate": {
      "name": "Capricornia"
    },
    "meshBlock": {
      "code": "30000000000",
      "category": "Residential"
    },
    "sa2": {
      "name": "Yeppoon",
      "code": "308011188"
    },
    "sa3": {
      "name": "Rockhampton",
      "code": "30801"
    },
    "sa4": {
      "name": "Central Queensland",
      "code": "308"
    },
    "ward": {
      "name": "Bambra Ward"
    },
    "sa1": "20802117831"
  },
  "sourceDataRelease": "2026.04",
  "addressRole": "SECONDARY",
  "legalParcelId": "14\\PS349838",
  "components": {
    "flatType": "FLAT",
    "flatNumber": "14",
    "streetNumberFirst": "5",
    "streetName": "DUKE",
    "streetType": "STREET"
  },
  "allGeocodes": [
    {
      "latitude": -37.89180933,
      "longitude": 145.01510717,
      "type": "FRONTAGE CENTRE SETBACK",
      "reliability": 2
    },
    {
      "latitude": -37.89180905,
      "longitude": 145.01490263,
      "type": "PROPERTY CENTROID",
      "reliability": 2
    }
  ],
  "locality": {
    "id": "loc1b5a0e70afd4",
    "classification": "GAZETTED LOCALITY",
    "neighbours": [
      "ELSTERNWICK",
      "GARDENVALE",
      "ORMOND"
    ],
    "aliases": []
  },
  "street": {
    "id": "VIC1953679",
    "classification": "CONFIRMED",
    "aliases": []
  },
  "aliases": [
    {
      "id": "MA13517230",
      "addressLabel": "SHOP 1 GROUND 1 MCNAB AVENUE",
      "type": "SYNONYM"
    }
  ],
  "secondaries": [
    {
      "id": "GAVIC425495838",
      "addressLabel": "SHOP 1 1 MCNAB AVENUE"
    }
  ]
}

{
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid query parameters",
    "status": 400,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z",
    "details": {
      "q": [
        "Required"
      ]
    }
  }
}

{
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing X-Api-Key header",
    "status": 401,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "PRODUCT_NOT_ALLOWED",
    "message": "Product not included in your plan",
    "status": 403,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Address not found: F_GAVIC999000002",
    "status": 404,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded",
    "status": 429,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error",
    "status": 500,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

Use Enrich after Autocomplete or Validate returns a G-NAF address ID and you need geocode, location, boundary, electorate, mesh block, or ABS geography fields. For field interpretation and SDK examples, see the Enrich guide.

Authorizations

X-Api-Key

string

header

required

Query Parameters

string

required

G-NAF address document ID. Paste an id value returned from Autocomplete or Validate.

Minimum string length: 1

Example:

"GAQLD156786950"

debug

enum<string>

Optional diagnostic flag. Send exactly true or false. Invalid values are rejected; debug diagnostics are for support only and must not be used for business decisions.

Available options:

true,

false

Example:

"false"

Response

Full enriched public address document for the requested id.

Enrich-only address document with structured components, extra geocodes, locality and street context, aliases, secondaries, extended boundaries, and optional diagnostic metadata when debug=true.

string

required

Opaque G-NAF persistent identifier for this address record. Store it as a string and pass it to Enrich when you need the full public address document.

Example:

"GAQLD156786950"

addressLabel

string | null

Formatted street-address line for display and form population. It usually contains the street number, street name, and any unit or building text available in the source record.

Example:

"9 ENDEAVOUR COURT"

localityName

string | null

Official suburb or locality name associated with the address.

Example:

"LAMMERMOOR"

state

enum<string> | null

Uppercase Australian state or territory code returned by the Address API. Allowed values are NSW New South Wales, VIC Victoria, QLD Queensland, SA South Australia, WA Western Australia, TAS Tasmania, NT Northern Territory, and ACT Australian Capital Territory.

Available options:

NSW,

VIC,

QLD,

SA,

WA,

TAS,

NT,

ACT

Example:

"QLD"

postcode

string | null

Four-digit Australian postcode. Store postcodes as strings; integer coercion can remove leading zeroes used by some Australian postcodes.

Pattern: ^\d{4}$

Example:

"4703"

confidence

integer | null

G-NAF source-record confidence metadata. -1 represents a retired record; 0, 1, and 2 indicate one, two, or three supporting contributor datasets. This is provenance metadata, not Prontiq match quality.

Required range: -1 <= x <= 2

Example:

2

geocode

object | null

G-NAF geocoding metadata and decimal-degree coordinates for the address.

Show child attributes

Example:

{
  "latitude": -23.1601,
  "longitude": 150.7596,
  "type": "PROPERTY CENTROID",
  "reliability": 2
}

location

object | null

Compact latitude/longitude point used for proximity workflows and map display.

Show child attributes

Example:

{ "lat": -23.1601, "lon": 150.7596 }

boundaries

object | null

Administrative, electoral, and ABS geography returned by Enrich. This is a strict superset of the standard address boundary object.

Show child attributes

Example:

{
  "lga": {
    "name": "Glen Eira",
    "code": "lga9bd137c30d17"
  },
  "stateElectorate": { "name": "Keppel" },
  "commonwealthElectorate": { "name": "Capricornia" },
  "meshBlock": {
    "code": "20192490000",
    "category": "Residential"
  },
  "sa2": {
    "name": "Caulfield - South",
    "code": "208021178"
  },
  "sa3": { "name": "Rockhampton", "code": "30801" },
  "sa4": {
    "name": "Central Queensland",
    "code": "308"
  },
  "ward": { "name": "Bambra Ward" },
  "sa1": "20802117831"
}

sourceDataRelease

string | null

Source data release or version used to produce the enriched address record when available. This is not the Prontiq API version.

Example:

"2026.04"

addressRole

enum<string> | null

Primary or secondary address role when available. Primary records are parent or building-level addresses; secondary records are child or unit-level addresses.

Available options:

PRIMARY,

SECONDARY

Example:

"SECONDARY"

components

object

Structured address components when available for the enriched record.

Show child attributes

Example:

{
  "flatType": "FLAT",
  "flatNumber": "14",
  "streetNumberFirst": "5",
  "streetName": "DUKE",
  "streetType": "STREET"
}

legalParcelId

string | null

Parcel or legal-property reference when available for the address. Coverage varies by address and source data.

Example:

"14\\PS349838"

allGeocodes

object[]

Additional geocodes associated with the address. The array preserves source order after invalid coordinates are removed.

Show child attributes

Example:

[
  {
    "latitude": -37.89180933,
    "longitude": 145.01510717,
    "type": "FRONTAGE CENTRE SETBACK",
    "reliability": 2
  },
  {
    "latitude": -37.89180905,
    "longitude": 145.01490263,
    "type": "PROPERTY CENTROID",
    "reliability": 2
  }
]

locality

object

Locality context when available for the enriched address.

Show child attributes

Example:

{
  "id": "loc1b5a0e70afd4",
  "classification": "GAZETTED LOCALITY",
  "neighbours": ["ELSTERNWICK", "GARDENVALE", "ORMOND"],
  "aliases": []
}

street

object

Street context when available for the enriched address.

Show child attributes

Example:

{
  "id": "VIC1953679",
  "classification": "CONFIRMED",
  "aliases": []
}

aliases

object[]

Alternative address labels associated with the enriched address.

Show child attributes

secondaries

object[]

Secondary or child addresses associated with the enriched address.

Show child attributes

debug

object

Optional diagnostic metadata returned only when debug=true is supplied. Debug values are for support and troubleshooting, not production decision-making.

Show child attributes

Example:

{
  "scoringVersion": "address-match-v1",
  "queryMode": "autocomplete",
  "searchScore": 42.1
}

Validate

Reverse Geocode

Enrich an address by ID

curl --request GET \
  --url https://api.prontiq.dev/v1/address/enrich \
  --header 'X-Api-Key: <api-key>'

const url = 'https://api.prontiq.dev/v1/address/enrich';
const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.prontiq.dev/v1/address/enrich"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.get("https://api.prontiq.dev/v1/address/enrich")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prontiq.dev/v1/address/enrich"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prontiq.dev/v1/address/enrich")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "GAQLD156786950",
  "addressLabel": "9 ENDEAVOUR COURT",
  "localityName": "LAMMERMOOR",
  "state": "QLD",
  "postcode": "4703",
  "confidence": 2,
  "geocode": {
    "latitude": -23.1601,
    "longitude": 150.7596,
    "type": "PROPERTY CENTROID",
    "reliability": 2
  },
  "location": {
    "lat": -23.1601,
    "lon": 150.7596
  },
  "boundaries": {
    "lga": {
      "name": "Glen Eira",
      "code": "lga9bd137c30d17"
    },
    "stateElectorate": {
      "name": "Keppel"
    },
    "commonwealthElectorate": {
      "name": "Capricornia"
    },
    "meshBlock": {
      "code": "30000000000",
      "category": "Residential"
    },
    "sa2": {
      "name": "Yeppoon",
      "code": "308011188"
    },
    "sa3": {
      "name": "Rockhampton",
      "code": "30801"
    },
    "sa4": {
      "name": "Central Queensland",
      "code": "308"
    },
    "ward": {
      "name": "Bambra Ward"
    },
    "sa1": "20802117831"
  },
  "sourceDataRelease": "2026.04",
  "addressRole": "SECONDARY",
  "legalParcelId": "14\\PS349838",
  "components": {
    "flatType": "FLAT",
    "flatNumber": "14",
    "streetNumberFirst": "5",
    "streetName": "DUKE",
    "streetType": "STREET"
  },
  "allGeocodes": [
    {
      "latitude": -37.89180933,
      "longitude": 145.01510717,
      "type": "FRONTAGE CENTRE SETBACK",
      "reliability": 2
    },
    {
      "latitude": -37.89180905,
      "longitude": 145.01490263,
      "type": "PROPERTY CENTROID",
      "reliability": 2
    }
  ],
  "locality": {
    "id": "loc1b5a0e70afd4",
    "classification": "GAZETTED LOCALITY",
    "neighbours": [
      "ELSTERNWICK",
      "GARDENVALE",
      "ORMOND"
    ],
    "aliases": []
  },
  "street": {
    "id": "VIC1953679",
    "classification": "CONFIRMED",
    "aliases": []
  },
  "aliases": [
    {
      "id": "MA13517230",
      "addressLabel": "SHOP 1 GROUND 1 MCNAB AVENUE",
      "type": "SYNONYM"
    }
  ],
  "secondaries": [
    {
      "id": "GAVIC425495838",
      "addressLabel": "SHOP 1 1 MCNAB AVENUE"
    }
  ]
}

{
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid query parameters",
    "status": 400,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z",
    "details": {
      "q": [
        "Required"
      ]
    }
  }
}

{
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing X-Api-Key header",
    "status": 401,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "PRODUCT_NOT_ALLOWED",
    "message": "Product not included in your plan",
    "status": 403,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Address not found: F_GAVIC999000002",
    "status": 404,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded",
    "status": 429,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error",
    "status": 500,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}