Validate - prontiq

GET

https://api.prontiq.dev

address

validate

Validate an address

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

const url = 'https://api.prontiq.dev/v1/address/validate';
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/validate"

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/validate")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

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

func main() {

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

	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/validate")

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

{
  "match": {
    "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": "Livingstone Shire"
      },
      "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"
      }
    }
  },
  "prontiqMatchScore": 92,
  "prontiqMatchQuality": "high"
}

{
  "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": "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 Validate when you already have a complete free-text address and need the best matching G-NAF record plus Prontiq match-quality fields. For match-quality handling and SDK examples, see the Validate guide.

Authorizations

X-Api-Key

string

header

required

Query Parameters

string

required

Free-text address to validate against G-NAF. Include suburb, state, and postcode when available for the strongest match signal.

Required string length: 1 - 500

Example:

"9 endeavour court lammermoor qld 4703"

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

Best address match, or match: null when the input does not resolve cleanly.

Best address match and Prontiq match-quality classification for a submitted address string.

match

object | null

required

Best matching full address document, or null when the submitted address does not resolve to a usable G-NAF record.

Show child attributes

Example:

{
  "id": "GAQLD156786950",
  "addressLabel": "9 ENDEAVOUR COURT",
  "localityName": "LAMMERMOOR",
  "state": "QLD",
  "postcode": "4703",
  "confidence": 2
}

prontiqMatchScore

integer

required

Prontiq-computed request match score from 0 to 100. Use it to decide whether to accept the match, ask the user to confirm, or request correction.

Required range: 0 <= x <= 100

Example:

92

prontiqMatchQuality

enum<string>

required

Human-readable Prontiq match-quality bucket derived from prontiqMatchScore. This is distinct from match.confidence, which is G-NAF source-record metadata.

Available options:

high,

medium,

low,

none

Example:

"high"

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
}

Autocomplete

Enrich

Validate an address

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

const url = 'https://api.prontiq.dev/v1/address/validate';
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/validate"

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/validate")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

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

func main() {

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

	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/validate")

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

{
  "match": {
    "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": "Livingstone Shire"
      },
      "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"
      }
    }
  },
  "prontiqMatchScore": 92,
  "prontiqMatchQuality": "high"
}

{
  "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": "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"
  }
}