Address object format

Selected address object

onSelect receives structured JSON for the selected address. Store the fields your application needs and keep the dataset version for debugging future address changes.

Example object

{
  "streetkit_id": "sk_linz_123456",
  "country": "NZ",
  "dataset_version": "linz-nz-addresses-2026-05",
  "source": {
    "provider": "LINZ",
    "dataset": "NZ Addresses",
    "layer_id": 123113,
    "address_id": "123456",
    "duplicate_source_ids": []
  },
  "display": {
    "label": "12 Queen Street, Auckland Central, Auckland",
    "line1": "12 Queen Street",
    "line2": null,
    "town_city": "Auckland",
    "postcode": "1010"
  },
  "components": {
    "unit": null,
    "level": null,
    "address_number": {
      "number": 12,
      "suffix": null,
      "high": null,
      "display": "12"
    },
    "road": {
      "name": "Queen",
      "type": "Street",
      "display": "Queen Street"
    },
    "suburb_locality": "Auckland Central",
    "town_city": "Auckland",
    "territorial_authority": "Auckland",
    "postcode": "1010"
  },
  "coordinates": {
    "latitude": -36.8485,
    "longitude": 174.7633,
    "crs": "EPSG:4167"
  },
  "metadata": {
    "is_current": true,
    "is_land": true,
    "is_water": false
  }
}

Field guidance

  • Use display.label for the human-readable selected address.
  • Use display.line1, display.line2, and components for form storage.
  • Keep streetkit_id and dataset_version if you need to debug future data changes.
  • postcode and coordinates may be absent when the selected source data does not provide them.
  • Coordinates, when present, are address data fields. They are not delivery-point certification.