react-native-okhi
    Preparing search index...

    Type Alias OkHiLocation

    Comprehensive location data returned once verification starts successfully.

    Contains all available address information collected. Properties may be null if not available for the specific location.

    const handleVerification = async () => {
      const result = await OkHi.startDigitalAddressVerification();
      const { location } = result;

      console.log('Address:', location.formattedAddress);
      console.log('Coordinates:', location.lat, location.lng);
      console.log('Plus Code:', location.plusCode);
    };

    OkHiSuccessResponse - Parent response type

    type OkHiLocation = {
        id?: string | null;
        lat?: number | null;
        lng?: number | null;
        placeId?: string | null;
        plusCode?: string | null;
        propertyName?: string | null;
        streetName?: string | null;
        title?: string | null;
        subtitle?: string | null;
        directions?: string | null;
        otherInformation?: string | null;
        url?: string | null;
        streetViewPanoId?: string | null;
        streetViewPanoUrl?: string | null;
        userId?: string | null;
        photoUrl?: string | null;
        propertyNumber?: string | null;
        country?: string | null;
        state?: string | null;
        city?: string | null;
        displayTitle?: string | null;
        countryCode?: string | null;
        neighborhood?: string | null;
        usageTypes?: string[] | null;
        ward?: string | null;
        formattedAddress?: string | null;
        postCode?: string | null;
    }
    Index

    Properties

    id? lat? lng? placeId? plusCode? propertyName? streetName? title? subtitle? directions? otherInformation? url? streetViewPanoId? streetViewPanoUrl? userId? photoUrl? propertyNumber? country? state? city? displayTitle? countryCode? neighborhood? usageTypes? ward? formattedAddress? postCode?

    Properties

    id?: string | null

    Unique OkHi location identifier. Use this to reference the address in future API calls.

    lat?: number | null

    Latitude coordinate of the location.

    `1.2921`
    lng?: number | null

    Longitude coordinate of the location.

    `36.8219`
    placeId?: string | null

    Legacy not in use

    plusCode?: string | null

    Open Location Code (Plus Code) for the address. A short, alphanumeric code that represents a geographic location.

    https://plus.codes/

    `'6GCRMQPX+JF'`
    propertyName?: string | null

    Name of the property (building, apartment complex, etc.).

    `'Sunrise Apartments'`
    streetName?: string | null

    Name of the street.

    `'Ngong Road'`
    title?: string | null

    System generated title for the address.

    subtitle?: string | null

    System generated subtitle for the address.

    directions?: string | null

    User-provided directions to the location.

    otherInformation?: string | null

    Additional information about the location.

    url?: string | null

    OkHi URL for the address. Can be shared for navigation purposes.

    streetViewPanoId?: string | null

    Google Street View panorama ID. Used to display street-level imagery.

    streetViewPanoUrl?: string | null

    URL to the Google Street View panorama image.

    userId?: string | null

    OkHi user ID associated with this location.

    photoUrl?: string | null

    URL to a photo of the location.

    propertyNumber?: string | null

    Property or house number.

    `'42'`
    country?: string | null

    Country name.

    `'Kenya'`
    state?: string | null

    State, province, or region.

    `'Nairobi'`
    city?: string | null

    City or town name.

    `'Nairobi'`
    displayTitle?: string | null

    Display-friendly title for the address. Formatted for showing in UI.

    countryCode?: string | null

    ISO 3166-1 alpha-2 country code.

    `'KE'`
    neighborhood?: string | null

    Neighborhood or locality name.

    `'Westlands'`
    usageTypes?: string[] | null

    Used internally by the SDK

    ward?: string | null

    Administrative ward. Common in African addressing systems.

    formattedAddress?: string | null

    Complete formatted address string.

    `'Sunrise Apartments, Ngong Road, Westlands, Nairobi, Kenya'`
    postCode?: string | null

    Postal or ZIP code.

    Settings

    Member Visibility

    On This Page

    Properties