React Native

Пакет @neurovision/react-native-kyc проводит сессию в нативных SDK (Android ru.neurovision.kyc:kyc-sdk, iOS NeuroVisionKyc); результат возвращается в JavaScript.

Требования

React Native
Android
iOS
Expo

Установка

Пока пакета нет в npm, он поставляется в пакете SDK: сам пакет — sdk/react-native/neurovision-react-native-kyc-0.6.2.tgz, Android SDK, от которого он зависит, — в sdk/android/maven/.

1. Скопируйте оба в свой проект, например в third_party/.

2. Установите пакет из архива:

npm install ./third_party/neurovision-react-native-kyc-0.6.2.tgz

3. Android SDK из папки Maven — в android/build.gradle:

allprojects {
    repositories {
        maven {
            url = new File(rootProject.projectDir, "../third_party/neurovision-maven").toURI()
            content { includeGroup("ru.neurovision.kyc") }
        }
    }
}

4. iOS: cd ios && pod install.

Пакет несёт iOS-фреймворк внутри: для iOS больше ничего скачивать не нужно. Когда пакет появится в npm, архив заменится версией, а блок maven { … } уйдёт.

Android

Поставьте minSdkVersion = 26 в блоке ext файла android/build.gradle приложения.

Нативный SDK поставляется для arm64-v8a и armeabi-v7a. React Native-приложение несёт собственные библиотеки x86_64, поэтому на устройстве или эмуляторе x86_64 оно работает как x86_64, и сессия не запускается: start сразу возвращает { kind: 'failed', reason: 'unsupportedDevice' } — покажите пользователю, что это устройство не поддерживается. Проверяйте на эмуляторе arm64 или устройстве.

launchMode у MainActivity. Шаблон React Native ставит singleTask. С ним, если пользователь уйдёт из приложения во время сессии и вернётся через иконку, сессия будет потеряна (cancelled). Используйте singleTop (или standard по умолчанию), если singleTask не нужен приложению для deep links.

iOS

Оставьте в Podfile собственную строку React Native platform :ios, min_ios_version_supported (15.1, выше минимума SDK 15.0) и добавьте в Info.plist текст об использовании камеры:

<key>NSCameraUsageDescription</key>
<string>The camera photographs your document and films the liveness check.</string>

Статическая линковка (по умолчанию) работает; USE_FRAMEWORKS=static|dynamic в Release — тоже. Debug-сборка с USE_FRAMEWORKS в React Native 0.87.1 не линкуется: недостающие символы — самого React Native (отладочный код Fabric и Hermes), а не этого пакета.

Использование

import { NeuroVisionKyc, KycError, type KycResult } from '@neurovision/react-native-kyc';

try {
  const result: KycResult = await NeuroVisionKyc.start({
    apiHost: apiHost,      // the address NeuroVision sent you
    schemaId,
    clientKey,         // from your server
    clientUser: userId, // optional: your user's id, the same in all their checks
    language: 'en',    // optional; default: the scenario's
    theme: 'auto',     // optional: 'auto' | 'light' | 'dark'
  });
  // or: NeuroVisionKyc.start({ apiHost, taskId, clientUser: userId })
  switch (result.kind) {
    case 'completed': // the server judged the session
      console.log(result.verdict); // 'success' | 'failed' | 'suspicious' | 'expired' | 'unknown'
      break;
    case 'cancelled': // the user left before the end
      break;
    case 'failed': // the session could not go on
      console.log(result.reason, result.message);
      // 'cameraDenied' | 'network' | 'server' | 'camera' | 'config' | 'unsupportedDevice' | 'internal'
      break;
  }
} catch (e) {
  if (e instanceof KycError) {
    // misuse, never a session's outcome:
    // 'already_running' | 'bad_request' | 'no_activity' (Android) | 'no_view_controller' (iOS)
  }
}

NeuroVisionKyc.sdkVersion(); // the native SDK's version, synchronously

Любой исход сессии — отмена, отказ в камере, отсутствие сети — это KycResult, а не исключение. Значения, которые может добавить более новый SDK, читаются как verdict: 'unknown' / reason: 'internal'.

Что означает каждый результат и что показать пользователю — Результаты. Откуда берутся значения запроса — Интеграция с сервером.

Отказы

KycError already_running
KycError bad_request
{ kind: 'failed', reason: 'config' }
{ kind: 'failed', reason: 'unsupportedDevice' }

Аналитика (по желанию)

SDK может отправлять продуктовую аналитику в проект PostHog, который указывает ваше приложение в своих нативных настройках; в самом SDK ключа нет. Android — android/app/src/main/AndroidManifest.xml:

<application …>
    <meta-data android:name="NeuroVisionKycPostHogKey" android:value="phc_…" />
    <meta-data android:name="NeuroVisionKycPostHogHost" android:value="https://us.i.posthog.com" />
</application>

iOS — ios/<App>/Info.plist:

<key>NeuroVisionKycPostHogKey</key>
<string>phc_…</string>
<key>NeuroVisionKycPostHogHost</key>
<string>https://us.i.posthog.com</string>

Без ключа SDK аналитику не отправляет. Держите ключ вне git: плейсхолдеры манифеста из android/gradle.properties или переменных окружения и $(KYC_POSTHOG_KEY) в Info.plist из окружения iOS-сборки. Что отправляется — Аналитика и приватность.

Ограничения

  • Сессия — полноэкранный нативный экран (activity на Android, модальный контроллер на iOS); встроить её в дерево компонентов нельзя.
  • Если Android завершит процесс приложения, пока на экране сессия, результат будет потерян: приложение перезапустится без ожидающего promise.
  • Перезагрузка JavaScript (только при разработке), пока на экране сессия: на iOS сессия закрывается, а её результат отбрасывается; на Android перезагрузка не дойдёт до приостановленного приложения, пока сессия не закончится.