Flutter

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

Требования

Flutter
Android
iOS

Установка

Пока плагина нет на pub.dev, он поставляется в пакете SDK: сам плагин — в sdk/flutter/neurovision_kyc/, Android SDK, от которого он зависит, — в sdk/android/maven/.

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

2. pubspec.yaml:

dependencies:
  neurovision_kyc:
    path: third_party/neurovision_kyc

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

allprojects {
    repositories {
        maven {
            url = uri(rootProject.projectDir.resolve("../third_party/neurovision-maven"))
            content { includeGroup("ru.neurovision.kyc") }
        }
        google()
        mavenCentral()
    }
}

rootProject.projectDir — это папка android/ вашего приложения. Оставьте его в пути: один uri("…") в allprojects разрешался бы относительно папки каждого плагина.

4. flutter pub get.

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

Android

Поставьте minSdk = 26 в android/app/build.gradle.kts.

Нативный SDK поставляется для arm64-v8a и armeabi-v7a. Flutter-приложение несёт собственные библиотеки x86_64, поэтому на устройстве или эмуляторе x86_64 оно работает как x86_64, и сессия не запускается: start сразу возвращает KycFailed(KycFailure.unsupportedDevice, …) — покажите пользователю, что это устройство не поддерживается. Проверяйте на эмуляторе arm64 или устройстве.

launchMode у MainActivity. Шаблон Flutter ставит singleTop — оставьте его. С singleTask, если пользователь уйдёт из приложения во время сессии и вернётся через иконку, сессия будет потеряна (KycCancelled).

iOS

Поставьте deployment target у target Runner 15.0 (platform :ios, '15.0' в Podfile, если он есть) и добавьте в Info.plist текст об использовании камеры:

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

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

import 'package:neurovision_kyc/neurovision_kyc.dart';
import 'package:flutter/services.dart';

try {
  final result = await NeuroVisionKyc.start(KycRequest(
    apiHost: apiHost,      // the address NeuroVision sent you
    schemaId: schemaId,
    clientKey: 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: KycTheme.auto,  // optional: auto | light | dark
  ));
  // or: NeuroVisionKyc.start(KycRequest.task(apiHost: apiHost, taskId: taskId, clientUser: userId))
  switch (result) {
    case KycCompleted(:final verdict): // the server judged the session
      print(verdict); // success | failed | suspicious | expired | unknown
    case KycCancelled(): // the user left before the end
      break;
    case KycFailed(:final reason, :final message): // the session could not go on
      print('$reason $message'); // cameraDenied | network | server | camera | config | unsupportedDevice | internal
  }
} on PlatformException catch (e) {
  // misuse, never a session's outcome:
  // already_running | bad_request | no_activity (Android) | no_view_controller (iOS)
}

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

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

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

Отказы

PlatformException('already_running')
PlatformException('bad_request')
KycFailed(KycFailure.config, …)
KycFailed(KycFailure.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/Runner/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 из .xcconfig, который не попадает в git. Что отправляется — Аналитика и приватность.

Ограничения

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