Verify v1 · Address

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.

Validate

POST

https://api.geoscape.com.au

/v1/verify/address/validate/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Assess one Australian address and return a recommended nextAction based on the first candidate.

Exact match quality returns ACCEPT
Confident match quality returns ACCEPT_WITH_CHANGES
Other quality levels or no candidate return DENY

A denied result can still include a candidate's id and formatted. These fields are omitted when unavailable. 200 means the check completed, not that the address was accepted.

Available on Free and paid plans. Each processed request costs 1 credit. See Interpreting Results for decision examples.

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/validate/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Place Sydney NSW 2000"}'

Validate › Request Body

VerifyV1_addressValidateAURequest

query

string · minLength: 1 · maxLength: 200 · required

The address string to check.

Validate › Responses

Address assessment completed. A DENY decision is returned as a normal result.

VerifyV1_addressValidateAUResponse

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_addressValidateAURequest · required

nextAction

string · enum · required

Recommended action based on the first candidate. Exact returns ACCEPT, Confident returns ACCEPT_WITH_CHANGES, and other quality levels or no candidate return DENY. A denied candidate can still have id and formatted values.

Enum values:

ACCEPT_WITH_CHANGES

DENY

id

string

Matched address identifier. Omitted when no identifier is available.

formatted

string

Matched formatted address. Omitted when no match is available.

POST/v1/verify/address/validate/AU

curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/validate/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Place Sydney NSW 2000"}'

Example Request Body

{
  "query": "1 Martin Place Sydney NSW 2000"
}

json

application/json

Example Responses

{
  "input": {
    "query": "1 Martin Place Sydney NSW 2000"
  },
  "nextAction": "ACCEPT",
  "id": "GANSW705988020",
  "formatted": "1 MARTIN PL, SYDNEY NSW 2000",
  "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

Geocode

POST

https://api.geoscape.com.au

/v1/verify/address/geocode/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find Australian address locations from one address string. Return up to maxResults ranked features.

Each feature has point geometry, rank, and an address ID and formatted label when available
No matches returns 200 with an empty features array
Coordinates use GDA94 (EPSG:4283), in [longitude, latitude] order

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

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/geocode/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Place Sydney NSW 2000","maxResults":5}'

Geocode › Request Body

VerifyV1_addressGeocodeAURequest

query

string · minLength: 1 · maxLength: 200 · required

The address string to search for.

maxResults

integer · min: 1 · max: 20

The maximum number of results per search.

Default: 5

Geocode › Responses

Geocoding completed. No matching features are reported in the response body.

VerifyV1_addressGeocodeAUResponse

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.

type

string · enum · required

Enum values:

FeatureCollection

crs

string · enum · required

Coordinate reference system of the returned geometry (GDA94).

Enum values:

https://www.opengis.net/def/crs/EPSG/0/4283

VerifyV1_addressGeocodeAURequest · required

VerifyV1_addressGeocodeFeatureAU[] · required

POST/v1/verify/address/geocode/AU

curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/geocode/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Place Sydney NSW 2000","maxResults":5}'

Example Request Body

{
  "query": "1 Martin Place Sydney NSW 2000",
  "maxResults": 5
}

json

application/json

Example Responses

{
  "type": "FeatureCollection",
  "crs": "https://www.opengis.net/def/crs/EPSG/0/4283",
  "input": {
    "query": "1 Martin Place Sydney NSW 2000",
    "maxResults": 5
  },
  "features": [
    {
      "type": "Feature",
      "id": "GANSW705988020",
      "geometry": {
        "type": "Point",
        "coordinates": [
          151.2,
          -33.8
        ]
      },
      "properties": {
        "formatted": "1 MARTIN PL, SYDNEY NSW 2000",
        "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

Reverse Geocode

POST

https://api.geoscape.com.au

/v1/verify/address/reverse-geocode/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find Australian addresses near the supplied latitude and longitude. Return up to maxResults ranked features.

matchDistance, when available, is the distance from the query point to the address point in metres
No matches returns 200 with an empty features array
Coordinates use GDA94 (EPSG:4283), in [longitude, latitude] order

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

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/reverse-geocode/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"latitude":-33.8,"longitude":151.2,"maxResults":5}'

Reverse Geocode › Request Body

VerifyV1_addressReverseGeocodeAURequest

latitude

number · min: -45 · max: -8 · required

Latitude in decimal degrees. Both bounds are inclusive for Australian coverage.

longitude

number · min: 96 · max: 168 · required

Longitude in decimal degrees. Both bounds are inclusive for Australian coverage.

maxResults

integer · min: 1 · max: 20

The maximum number of results per search.

Default: 5

Reverse Geocode › Responses

Reverse geocoding completed. No matching features are reported in the response body.

VerifyV1_addressReverseGeocodeAUResponse

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.

type

string · enum · required

Enum values:

FeatureCollection

crs

string · enum · required

Coordinate reference system of the returned geometry (GDA94).

Enum values:

https://www.opengis.net/def/crs/EPSG/0/4283

VerifyV1_addressReverseGeocodeAURequest · required

VerifyV1_addressReverseGeocodeFeatureAU[] · required

POST/v1/verify/address/reverse-geocode/AU

curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/reverse-geocode/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"latitude":-33.8,"longitude":151.2,"maxResults":5}'

Example Request Body

{
  "latitude": -33.8,
  "longitude": 151.2,
  "maxResults": 5
}

json

application/json

Example Responses

{
  "type": "FeatureCollection",
  "crs": "https://www.opengis.net/def/crs/EPSG/0/4283",
  "input": {
    "latitude": -33.8,
    "longitude": 151.2,
    "maxResults": 5
  },
  "features": [
    {
      "type": "Feature",
      "id": "GANSW705988020",
      "geometry": {
        "type": "Point",
        "coordinates": [
          151.2,
          -33.8
        ]
      },
      "matchDistance": 14.5,
      "properties": {
        "formatted": "1 MARTIN PL, SYDNEY NSW 2000",
        "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

Info

POST

https://api.geoscape.com.au

/v1/verify/address/info/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve details for a known Australian address ID. Return a single Feature with address properties and a formatted label.

Geometry is omitted when unavailable
An unknown ID returns 200 with empty properties
An invalid ID format returns 400

Available on Free and paid plans. Each processed request costs 1 credit. See Interpreting Results for lookup handling.

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/info/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"id":"GANSW705988020"}'

Info › Request Body

VerifyV1_addressInfoAURequest

id

string · minLength: 1 · maxLength: 100 · pattern: ^[A-Za-z0-9_-]+$ · required

Address identifier. Letters, digits, underscores and hyphens are accepted.

Info › Responses

Address details were retrieved, or the identifier had no match.

VerifyV1_addressInfoAUResponse

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.

type

string · enum · required

Enum values:

Feature

crs

string · enum · required

Coordinate reference system of the returned geometry (GDA94).

Enum values:

https://www.opengis.net/def/crs/EPSG/0/4283

VerifyV1_addressInfoAURequest · required

object · required

Address attributes. The formatted address label is named formatted. Empty when the ID has no match.

VerifyV1_addressGeometry

POST/v1/verify/address/info/AU

curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/info/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"id":"GANSW705988020"}'

Example Request Body

{
  "id": "GANSW705988020"
}

json

application/json

Example Responses

{
  "type": "Feature",
  "crs": "https://www.opengis.net/def/crs/EPSG/0/4283",
  "input": {
    "id": "GANSW705988020"
  },
  "geometry": {
    "type": "Point",
    "coordinates": [
      151.2,
      -33.8
    ]
  },
  "properties": {
    "addressId": "GANSW705988020",
    "formatted": "1 MARTIN PL, SYDNEY NSW 2000",
    "localityName": "SYDNEY"
  },
  "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 · Autocomplete

Validate

POST

https://api.geoscape.com.au

/v1/verify/address/validate/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Assess one Australian address and return a recommended nextAction based on the first candidate.

Exact match quality returns ACCEPT
Confident match quality returns ACCEPT_WITH_CHANGES
Other quality levels or no candidate return DENY

A denied result can still include a candidate's id and formatted. These fields are omitted when unavailable. 200 means the check completed, not that the address was accepted.

Available on Free and paid plans. Each processed request costs 1 credit. See Interpreting Results for decision examples.

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/validate/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Place Sydney NSW 2000"}'

Validate › Request Body

VerifyV1_addressValidateAURequest

query

string · minLength: 1 · maxLength: 200 · required

The address string to check.

Validate › Responses

Address assessment completed. A DENY decision is returned as a normal result.

VerifyV1_addressValidateAUResponse

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_addressValidateAURequest · required

nextAction

string · enum · required

Enum values:

ACCEPT_WITH_CHANGES

DENY

id

string

Matched address identifier. Omitted when no identifier is available.

formatted

string

Matched formatted address. Omitted when no match is available.

Geocode

POST

https://api.geoscape.com.au

/v1/verify/address/geocode/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find Australian address locations from one address string. Return up to maxResults ranked features.

Each feature has point geometry, rank, and an address ID and formatted label when available
No matches returns 200 with an empty features array
Coordinates use GDA94 (EPSG:4283), in [longitude, latitude] order

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

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/geocode/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"query":"1 Martin Place Sydney NSW 2000","maxResults":5}'

Geocode › Request Body

VerifyV1_addressGeocodeAURequest

query

string · minLength: 1 · maxLength: 200 · required

The address string to search for.

maxResults

integer · min: 1 · max: 20

The maximum number of results per search.

Default: 5

Geocode › Responses

Geocoding completed. No matching features are reported in the response body.

VerifyV1_addressGeocodeAUResponse

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.

type

string · enum · required

Enum values:

FeatureCollection

crs

string · enum · required

Coordinate reference system of the returned geometry (GDA94).

Enum values:

https://www.opengis.net/def/crs/EPSG/0/4283

VerifyV1_addressGeocodeAURequest · required

VerifyV1_addressGeocodeFeatureAU[] · required

Reverse Geocode

POST

https://api.geoscape.com.au

/v1/verify/address/reverse-geocode/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Find Australian addresses near the supplied latitude and longitude. Return up to maxResults ranked features.

matchDistance, when available, is the distance from the query point to the address point in metres
No matches returns 200 with an empty features array
Coordinates use GDA94 (EPSG:4283), in [longitude, latitude] order

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

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/reverse-geocode/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"latitude":-33.8,"longitude":151.2,"maxResults":5}'

Reverse Geocode › Request Body

VerifyV1_addressReverseGeocodeAURequest

latitude

number · min: -45 · max: -8 · required

Latitude in decimal degrees. Both bounds are inclusive for Australian coverage.

longitude

number · min: 96 · max: 168 · required

Longitude in decimal degrees. Both bounds are inclusive for Australian coverage.

maxResults

integer · min: 1 · max: 20

The maximum number of results per search.

Default: 5

Reverse Geocode › Responses

Reverse geocoding completed. No matching features are reported in the response body.

VerifyV1_addressReverseGeocodeAUResponse

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.

type

string · enum · required

Enum values:

FeatureCollection

crs

string · enum · required

Coordinate reference system of the returned geometry (GDA94).

Enum values:

https://www.opengis.net/def/crs/EPSG/0/4283

VerifyV1_addressReverseGeocodeAURequest · required

VerifyV1_addressReverseGeocodeFeatureAU[] · required

Info

POST

https://api.geoscape.com.au

/v1/verify/address/info/AU

Authorization (header)

Authentication: Use your Consumer Key in the Authorization header.

Retrieve details for a known Australian address ID. Return a single Feature with address properties and a formatted label.

Geometry is omitted when unavailable
An unknown ID returns 200 with empty properties
An invalid ID format returns 400

Available on Free and paid plans. Each processed request costs 1 credit. See Interpreting Results for lookup handling.

Code
curl --fail-with-body \
  "https://api.geoscape.com.au/v1/verify/address/info/AU" \
  -H "Authorization: $GEOSCAPE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  --data '{"id":"GANSW705988020"}'

Info › Request Body

VerifyV1_addressInfoAURequest

id

string · minLength: 1 · maxLength: 100 · pattern: ^[A-Za-z0-9_-]+$ · required

Address identifier. Letters, digits, underscores and hyphens are accepted.

Info › Responses

Address details were retrieved, or the identifier had no match.

VerifyV1_addressInfoAUResponse

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.

type

string · enum · required

Enum values:

Feature

crs

string · enum · required

Coordinate reference system of the returned geometry (GDA94).

Enum values:

https://www.opengis.net/def/crs/EPSG/0/4283

VerifyV1_addressInfoAURequest · required

object · required

Address attributes. The formatted address label is named formatted. Empty when the ID has no match.

VerifyV1_addressGeometry