Optional cityA user's city
Optional countryA user's country
Optional countryA user's country code
Optional directionsUser generated directions to the location.
Optional displayA formatted location information
Optional idThe OkHi's locationId. Usually obtained once an address has been successfully created by the user.
The latitude of the location.
The longitude of the location.
Optional otherUser generated meta information about the location, how to access it and any other relevant notes.
Optional photoA link to the location's gate photo.
Optional placeThe id of a common residential or geological space such as apartment building or office block.
Optional plusGeocode system for identifying an area anywhere on the Earth. See https://plus.codes/
Optional propertyThe location's property name.
Optional propertyThe location's property number.
Optional stateA user's state
Optional streetThe location's street name.
Optional streetA Google's StreetView Panorama Id, if the address was created using Google StreetView. See: https://developers.google.com/maps/documentation/javascript/streetview
Optional streetA Google's StreetView Panorama Url, if the address was created using Google StreetView. See: https://developers.google.com/maps/documentation/javascript/streetview
Optional subtitleA string that can be used to render meta information about the location.
Optional titleA string that can be used to render information about the location.
Optional urlA link to the user's address visible on browser or desktop.
Optional userThe OkHi's userId. Usually obtained after a user successfully creates an OkHi address.
Optional verificationAn array of verification types that specifies the mode of verification. Can include "physical" and/or "digital" as valid values.
Generated using TypeDoc
Defines the structure of the OkHi location object once an address has been successfully created by the user.