react-native-okhi
    Preparing search index...

    Type Alias OkCollect

    Configuration options for address collection

    Pass this to verification functions to customize the address collection experience. All properties are optional - sensible defaults are applied automatically.

    import * as OkHi from 'react-native-okhi';
    import type { OkCollect } from 'react-native-okhi';

    // Use with custom styling
    const config: OkCollect = {
      style: {
        color: '#FF5722',
        logo: 'https://example.com/logo.png',
      },
      configuration: {
        streetView: true,
      },
    };

    const result = await OkHi.startDigitalAddressVerification(config);

    // Start verification on a previously created address.
    const locationId: string = await fetchLocationIdFromMyDatabase()
    const config: OkCollect = {
      locationId,
    };

    const result = await startPhysicalAddressVerification(config);
    type OkCollect = {
        style?: Partial<OkCollectStyle>;
        configuration?: Partial<OkCollectConfig>;
        locationId?: string;
    }
    Index

    Properties

    style? configuration? locationId?

    Properties

    style?: Partial<OkCollectStyle>

    Visual styling options for the collection UI. Partial - only specify the properties you want to override.

    configuration?: Partial<OkCollectConfig>

    Behavioral configuration for the collection UI. Partial - only specify the properties you want to override.

    locationId?: string

    OkHi identifier for the address Use this to start verification on a previously created address.

    Settings

    Member Visibility

    On This Page

    Properties