Selected address object

Example object

{
  "id": "linz:123456",
  "label": "12 Queen Street, Auckland Central, Auckland 1010",
  "components": {
    "unit": null,
    "level": null,
    "number": "12",
    "numberSuffix": null,
    "numberHigh": null,
    "street": "Queen Street",
    "streetName": "Queen",
    "streetType": "Street",
    "streetSuffix": null,
    "suburb": "Auckland Central",
    "city": "Auckland",
    "postcode": "1010",
    "territorialAuthority": "Auckland",
    "region": null,
    "country": "NZ"
  },
  "location": {
    "lat": -36.8485,
    "lon": 174.7633
  },
  "source": {
    "provider": "LINZ",
    "dataset": "NZ Addresses",
    "layer": "123113",
    "version": "fixture-v1",
    "exportedAt": "2026-05-08T00:00:00.000Z",
    "builtAt": "2026-05-08T00:00:00.000Z",
    "licence": "CC BY 4.0"
  },
  "confidence": {
    "score": 186,
    "matchType": "autocomplete"
  }
}

Field guidance

• Use label for the human-readable selected address.
• Known unavailable component fields are present as null, not empty strings or inferred values.
• Keep id, source.layer, source.version, source.exportedAt, and source.builtAt if you need to debug future data changes.
• source.licence identifies the source data licence for the selected record.
• postcode is included only when present in the source detail record and is not delivery certification.
• location.lat and location.lon, when present, are source address coordinates, not delivery-point certification.

Type shape

type StreetKitSelectedAddress = {
  id: string;
  label: string;
  components: {
    unit: string | null;
    level: string | null;
    number: string | null;
    numberSuffix: string | null;
    numberHigh: string | null;
    street: string | null;
    streetName: string | null;
    streetType: string | null;
    streetSuffix: string | null;
    suburb: string | null;
    city: string | null;
    postcode: string | null;
    territorialAuthority: string | null;
    region: string | null;
    country: "NZ";
  };
  location: {
    lat: number | null;
    lon: number | null;
  };
  source: {
    provider: "LINZ";
    dataset: "NZ Addresses";
    layer: "123113";
    version: string;
    exportedAt: string | null;
    builtAt: string | null;
    licence: "CC BY 4.0";
  };
  confidence: {
    score: number | null;
    matchType: "autocomplete";
  };
};

Unsupported fields

The v1 selected object is based on LINZ NZ Addresses layer 123113. It does not include DPID, NZ Post delivery point identifiers, delivered-only flags, PO Box, Private Bag, Counter Delivery, RD/mailtown, courier deliverability, or delivery certification fields.