Addresses v2 · Address Verification
A grouping of operations that retrieve address information.
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.
Required response fields must be present when their containing object is returned. Supply the documented request parameters when calling the endpoint.
Get address by ID
Authentication: Use your Consumer Key in the
Authorizationheader.
Retrieve one address, street, or locality using an identifier returned by an address search. Use this endpoint when you already know the ID. It does not validate a new address string.
Use additionalProperties for related attributes. Some require paid-plan access and incur additional charges. See Additional Properties.
Code
path Parameters
addressIdAddress, street, or locality identifier returned by an address search.
query Parameters
additionalPropertiesOptional related attributes. Send one comma-separated query value, for example additionalProperties=buildings,localGovernmentArea. Omit to return base attributes only. Names are case-sensitive.
Unavailable attributes may be omitted or reported in the feature’s messages array without failing the request. See Additional Properties for supported values, response fields, and access requirements.
Headers
AcceptPreferred response media type. Use application/geo+json for address search and lookup responses. MailPoint returns application/json.
Accept-CrsResponse coordinate reference system. Send angle-bracketed CRS URIs, separated by commas. Optional ;q= values set preference. Defaults to GDA94 (EPSG:4283).
Supported EPSG codes: 4283 (GDA94), 7844 (GDA2020), 4326 (WGS84), 4202 (AGD66), 3857 (Web Mercator), and 4167 (NZGD2000). See CRS selection and preferences.
Get address by ID › Responses
One GeoJSON address, street, or locality feature.
typeBase attributes for an address, street, or locality. Optional fields depend on the matched record. Requested additional properties appear here when available.
requestTimeStampRequest time in seconds since the Unix epoch (1970-01-01T00:00:00Z), including fractional seconds.
requestDateTimeRequest time in UTC in ISO 8601 form. The timezone suffix may be omitted.
attributionRights notice for the data returned
messagesSupplementary information about the request or result. A message can accompany a successful 200 response.