@uverifyng/react-native-liveness 0.1.0 → 0.2.0

package/README.md

@@ -25,6 +25,8 @@ React Native 0.72+, `react-native-webview` 13+. iOS 14.3+ (camera inside web vie
 <uses-permission android:name="android.permission.CAMERA" />
 ```
 
+Using address links? Also add location: `NSLocationWhenInUseUsageDescription` (iOS) and `<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />` (Android). If the link asks for a proof of address, the customer photographs it in the page: add `NSPhotoLibraryUsageDescription` (iOS) for the gallery; react-native-webview handles the file picker.
+
 ## Use
 
 Your **server** creates the session with a UVerify server SDK and returns its `url` and `id`. Never put your API key in the app.
@@ -57,6 +59,10 @@ The result in the app is only a hint to move on; **trust what your server gets f
 
 The same component opens a verification link (`link.url` from `kyc.createLink`): `onFinish` receives `{ type: 'kyc', id, status, outcome }`.
 
+### Address links
+
+It also opens an address link (`link.url` from `address.createLink`), where the customer shares their phone's location at home. The component asks for location instead of the camera, and `onFinish` receives `{ type: 'address', id, status, result }`. Read the distance and details on your server with `address.getLink(id)`.
+
 ### Options
 
 | Prop | |
@@ -64,7 +70,7 @@ The same component opens a verification link (`link.url` from `kyc.createLink`):
 | `url` | The session or link `url` from your server |
 | `redirectUrl` | The `redirect_url` you created it with, if any; reaching it also finishes (`{ type: 'redirect', params }`) |
 | `onFinish(result)` | The flow finished |
-| `onCancel(reason)` | Back button, or the camera was refused |
+| `onCancel(reason)` | `back`, or `camera_denied` / `location_denied` |
 | `allowedHosts` | Extra hosts allowed in the view (UVerify’s are always allowed; everything else is blocked) |
 
 MIT licence.

package/dist/UVerifyWebView.d.ts

@@ -2,25 +2,27 @@ import React from 'react';
 import { type StyleProp, type ViewStyle } from 'react-native';
 import { type UVerifyResult } from './events';
 export interface UVerifyWebViewProps {
-    /** A liveness session's `url`, or a verification link's `url` (from your server, via the UVerify API). */
+    /** A liveness session's, verification link's or address link's `url` (from your server, via the UVerify API). */
     url: string;
     /** The redirect_url you created the session/link with, if any: reaching it also finishes. */
     redirectUrl?: string;
     /** The flow finished. For liveness, pass `result.sessionId` to your server for the face match. */
     onFinish: (result: UVerifyResult) => void;
-    /** The person backed out (Android back button) or refused the camera. */
-    onCancel?: (reason: 'back' | 'camera_denied') => void;
+    /** The person backed out (Android back button), or refused the camera (location, for an address link). */
+    onCancel?: (reason: 'back' | 'camera_denied' | 'location_denied') => void;
     /** Extra hosts to allow (default: uverify.com.ng and its subdomains). */
     allowedHosts?: string[];
     style?: StyleProp<ViewStyle>;
 }
 /**
- * UVerify's hosted face check (or a verification link) inside your app. The
- * check itself runs on UVerify's page, the same one customers get in a
- * browser, so every anti-spoofing layer applies and improvements reach your
+ * UVerify's hosted face check, verification link or address link inside your
+ * app. The check itself runs on UVerify's page, the same one customers get in
+ * a browser, so every anti-spoofing layer applies and improvements reach your
  * app without an update.
  *
- * Needs the camera permission: add NSCameraUsageDescription to Info.plist and
- * <uses-permission android:name="android.permission.CAMERA" /> to AndroidManifest.xml.
+ * Face checks need the camera: NSCameraUsageDescription in Info.plist and
+ * <uses-permission android:name="android.permission.CAMERA" /> in AndroidManifest.xml.
+ * Address links need the location: NSLocationWhenInUseUsageDescription and
+ * <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />.
  */
 export declare function UVerifyWebView({ url, redirectUrl, onFinish, onCancel, allowedHosts, style }: UVerifyWebViewProps): React.JSX.Element;

package/dist/UVerifyWebView.js

@@ -39,15 +39,18 @@ const react_native_1 = require("react-native");
 const react_native_webview_1 = require("react-native-webview");
 const events_1 = require("./events");
 /**
- * UVerify's hosted face check (or a verification link) inside your app. The
- * check itself runs on UVerify's page, the same one customers get in a
- * browser, so every anti-spoofing layer applies and improvements reach your
+ * UVerify's hosted face check, verification link or address link inside your
+ * app. The check itself runs on UVerify's page, the same one customers get in
+ * a browser, so every anti-spoofing layer applies and improvements reach your
  * app without an update.
  *
- * Needs the camera permission: add NSCameraUsageDescription to Info.plist and
- * <uses-permission android:name="android.permission.CAMERA" /> to AndroidManifest.xml.
+ * Face checks need the camera: NSCameraUsageDescription in Info.plist and
+ * <uses-permission android:name="android.permission.CAMERA" /> in AndroidManifest.xml.
+ * Address links need the location: NSLocationWhenInUseUsageDescription and
+ * <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />.
  */
 function UVerifyWebView({ url, redirectUrl, onFinish, onCancel, allowedHosts = [], style }) {
+    const location = (0, events_1.needsLocation)(url);
     const [cameraOk, setCameraOk] = (0, react_1.useState)(react_native_1.Platform.OS !== 'android');
     const [denied, setDenied] = (0, react_1.useState)(false);
     const done = (0, react_1.useRef)(false);
@@ -58,19 +61,19 @@ function UVerifyWebView({ url, redirectUrl, onFinish, onCancel, allowedHosts = [
         done.current = true;
         onFinish(r);
     }, [onFinish]);
-    // Android: ask for the camera before the page does (the web view can only use it if the app has it).
+    // Android: ask for the camera (or location) before the page does: the web view can only use it if the app has it.
     (0, react_1.useEffect)(() => {
         if (react_native_1.Platform.OS !== 'android')
             return;
-        react_native_1.PermissionsAndroid.request(react_native_1.PermissionsAndroid.PERMISSIONS.CAMERA).then((r) => {
+        react_native_1.PermissionsAndroid.request(location ? react_native_1.PermissionsAndroid.PERMISSIONS.ACCESS_FINE_LOCATION : react_native_1.PermissionsAndroid.PERMISSIONS.CAMERA).then((r) => {
             if (r === react_native_1.PermissionsAndroid.RESULTS.GRANTED)
                 setCameraOk(true);
             else {
                 setDenied(true);
-                onCancel?.('camera_denied');
+                onCancel?.(location ? 'location_denied' : 'camera_denied');
             }
         });
-    }, [onCancel]);
+    }, [onCancel, location]);
     (0, react_1.useEffect)(() => {
         const sub = react_native_1.BackHandler.addEventListener('hardwareBackPress', () => {
             if (done.current)
@@ -96,7 +99,7 @@ function UVerifyWebView({ url, redirectUrl, onFinish, onCancel, allowedHosts = [
     };
     if (denied) {
         return (react_1.default.createElement(react_native_1.View, { style: [styles.center, style] },
-            react_1.default.createElement(react_native_1.Text, { style: styles.text }, "Camera access is needed for the face check. Allow it in Settings, then try again.")));
+            react_1.default.createElement(react_native_1.Text, { style: styles.text }, location ? 'Location access is needed to confirm your address. Allow it in Settings, then try again.' : 'Camera access is needed for the face check. Allow it in Settings, then try again.')));
     }
     if (!cameraOk) {
         return (react_1.default.createElement(react_native_1.View, { style: [styles.center, style] },
@@ -106,7 +109,8 @@ function UVerifyWebView({ url, redirectUrl, onFinish, onCancel, allowedHosts = [
         // iOS: camera inside the page, inline (not full-screen), no second prompt from WebKit.
         allowsInlineMediaPlayback: true, mediaPlaybackRequiresUserAction: false, mediaCapturePermissionGrantType: "grant", 
         // Android: react-native-webview passes the page's camera request through once the app holds CAMERA (asked above).
-        setSupportMultipleWindows: false, startInLoadingState: true, renderLoading: () => (react_1.default.createElement(react_native_1.View, { style: styles.center },
+        // Location (address links): Android web views only share it when enabled; iOS asks with the app's own permission.
+        geolocationEnabled: location, setSupportMultipleWindows: false, startInLoadingState: true, renderLoading: () => (react_1.default.createElement(react_native_1.View, { style: styles.center },
             react_1.default.createElement(react_native_1.ActivityIndicator, null))) }));
 }
 const styles = react_native_1.StyleSheet.create({

package/dist/events.d.ts

@@ -11,6 +11,13 @@ export type UVerifyResult = {
     id: string;
     status: string;
     outcome: string | null;
+}
+/** An address link: fetch it on your server for the distance and details. */
+ | {
+    type: 'address';
+    id: string;
+    status: 'completed' | 'expired';
+    result: 'verified' | 'partial' | 'failed' | null;
 } | {
     type: 'redirect';
     url: string;
@@ -20,5 +27,7 @@ export type UVerifyResult = {
 export declare function parseMessage(data: string): UVerifyResult | null;
 /** The page is sending the person back to your redirect_url: finish with its query parameters. */
 export declare function parseRedirect(url: string, redirectUrl: string | undefined): UVerifyResult | null;
+/** An address link (/address/<id>) needs the phone's location; everything else needs the camera. */
+export declare function needsLocation(url: string): boolean;
 /** Only UVerify's pages (and about:blank) load in the view; anything else is refused. */
 export declare function isAllowed(url: string, hosts: string[]): boolean;

package/dist/events.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseMessage = parseMessage;
 exports.parseRedirect = parseRedirect;
+exports.needsLocation = needsLocation;
 exports.isAllowed = isAllowed;
 /** The hosted page's "finished" message (posted by uverify.com.ng), or null if it's something else. */
 function parseMessage(data) {
@@ -18,6 +19,8 @@ function parseMessage(data) {
         return { type: 'liveness', sessionId: m.session_id, status: m.status };
     if (m.type === 'kyc.finished' && typeof m.id === 'string')
         return { type: 'kyc', id: m.id, status: m.status, outcome: m.outcome ?? null };
+    if (m.type === 'address.finished' && typeof m.id === 'string')
+        return { type: 'address', id: m.id, status: m.status, result: m.result ?? null };
     return null;
 }
 /** The page is sending the person back to your redirect_url: finish with its query parameters. */
@@ -35,6 +38,10 @@ function parseRedirect(url, redirectUrl) {
     }
     return { type: 'redirect', url, params };
 }
+/** An address link (/address/<id>) needs the phone's location; everything else needs the camera. */
+function needsLocation(url) {
+    return /^https:\/\/[^/]+\/address\//i.test(url);
+}
 /** Only UVerify's pages (and about:blank) load in the view; anything else is refused. */
 function isAllowed(url, hosts) {
     if (url === 'about:blank')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uverifyng/react-native-liveness",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "UVerify's face check (liveness) and verification links inside a React Native app.",
   "license": "MIT",
   "author": "Elasto Web Services Limited",