Verify v1 · Autocomplete

Download schema

Before calling these endpoints, use a Geoscape Hub application with access to this API product. Authenticate with your Consumer Key in the Authorization header. See Authentication, Error Handling, Rate Limiting, and Attribution for shared integration guidance.

Autocomplete

POST

https://api.geoscape.com.au

/v1/verify/autocomplete/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Suggest Australian addresses from a partial query. Use the selected ID with address info to retrieve details.

Leading and trailing query whitespace is removed before the 3–200 character length check
Results are ranked starting at 1. No suggestions returns 200 with an empty results array

Available on Free and paid plans. Each processed request costs 0.1 credits. See Interpreting Results for result handling.

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/autocomplete/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Pl","maxResults":3}'

Autocomplete › Request Body

VerifyV1_addressAutocompleteAURequest

query

string · minLength: 3 · maxLength: 200 · required

Partial address to search for. Leading and trailing whitespace is removed before checking the 3–200 character length.

type

string · enum

Type of suggestion to return. Only address is supported.

Enum values:

address

Default: address

maxResults

integer · min: 1 · max: 20

The maximum number of results per search.

Default: 5

Autocomplete › Responses

Suggestions returned. An empty results list is a successful no-match response.

VerifyV1_addressAutocompleteAUResponse

attribution

string · required

Data attribution notice.

requestTimeStamp

number · required

Unix timestamp in seconds for the response.

requestDateTime

string · date-time · required

UTC date and time for the request.

VerifyV1_addressAutocompleteAURequest · required

object[] · required

POST/v1/verify/autocomplete/AU

curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/autocomplete/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Pl","maxResults":3}'

Example Request Body

{
  "query": "1 Martin Pl",
  "maxResults": 3
}

json

application/json

Example Responses

{
  "input": {
    "query": "1 Martin Pl",
    "maxResults": 3
  },
  "results": [
    {
      "id": "GANSW705988020",
      "formatted": "1 MARTIN PL, SYDNEY NSW 2000",
      "type": "address",
      "rank": 1
    }
  ],
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Hub Terms and Conditions (https://geoscape.com.au/legal/geoscape-developer-terms/)",
  "requestTimeStamp": 1792540800,
  "requestDateTime": "2026-10-21T00:00:00+00:00"
}

json

application/json

Verify v1 · Address Verify v1 · Mailpoint

Geoscape API

Verify v1 · Autocomplete

Download schema

Autocomplete

POST

https://api.geoscape.com.au

/v1/verify/autocomplete/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Suggest Australian addresses from a partial query. Use the selected ID with address info to retrieve details.

Leading and trailing query whitespace is removed before the 3–200 character length check
Results are ranked starting at 1. No suggestions returns 200 with an empty results array

Available on Free and paid plans. Each processed request costs 0.1 credits. See Interpreting Results for result handling.

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/autocomplete/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Pl","maxResults":3}'

Autocomplete › Request Body

VerifyV1_addressAutocompleteAURequest

query

string · minLength: 3 · maxLength: 200 · required

Partial address to search for. Leading and trailing whitespace is removed before checking the 3–200 character length.

type

string · enum

Type of suggestion to return. Only address is supported.

Enum values:

address

Default: address

maxResults

integer · min: 1 · max: 20

The maximum number of results per search.

Default: 5

Autocomplete › Responses

Suggestions returned. An empty results list is a successful no-match response.

VerifyV1_addressAutocompleteAUResponse

attribution

string · required

Data attribution notice.

requestTimeStamp

number · required

Unix timestamp in seconds for the response.

requestDateTime

string · date-time · required

UTC date and time for the request.

VerifyV1_addressAutocompleteAURequest · required

object[] · required

POST/v1/verify/autocomplete/AU

curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/autocomplete/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Pl","maxResults":3}'

Example Request Body

{
  "query": "1 Martin Pl",
  "maxResults": 3
}

json

application/json

Example Responses

{
  "input": {
    "query": "1 Martin Pl",
    "maxResults": 3
  },
  "results": [
    {
      "id": "GANSW705988020",
      "formatted": "1 MARTIN PL, SYDNEY NSW 2000",
      "type": "address",
      "rank": 1
    }
  ],
  "attribution": "NOTICE All rights reserved. Use of this data is subject to the Geoscape Hub Terms and Conditions (https://geoscape.com.au/legal/geoscape-developer-terms/)",
  "requestTimeStamp": 1792540800,
  "requestDateTime": "2026-10-21T00:00:00+00:00"
}

json

application/json

Verify v1 · Address Verify v1 · Mailpoint