Android

Android SDK ru.neurovision.kyc:kyc-sdk (Kotlin, Jetpack Compose) проводит сессию в собственной activity и возвращает результат через Activity Result API.

Требования

minSdk
compileSdk
Android Gradle Plugin
Kotlin
Устройства

Устройство или эмулятор x86_64 с трансляцией ARM запускает приложение как ARM. Если приложение несёт собственные библиотеки x86_64, оно работает как x86_64, и сессия сразу завершается с Failed(UnsupportedDevice) — покажите пользователю, что это устройство не поддерживается. Проверяйте на устройстве или эмуляторе arm64.

SDK приносит Jetpack Compose (через Compose BOM, с которым он собран): если у приложения Compose старше, он поднимется до этой версии. androidx.activity — API-зависимость, так как NeuroVisionKyc.contract() возвращает его ActivityResultContract.

Установка

Пока SDK нет в Maven Central, он поставляется папкой Maven-репозитория в пакете SDK (sdk/android/maven/). Скопируйте её в свой проект, например как third_party/neurovision-maven/, и добавьте как репозиторий в settings.gradle.kts:

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

Добавьте зависимость в модуль приложения:

dependencies {
    implementation("ru.neurovision.kyc:kyc-sdk:0.6.2")
}

Собственные зависимости SDK (AndroidX, Compose, Kotlin) приходят, как обычно, из Google Maven и Maven Central. Когда SDK появится в Maven Central, блок maven { … } уйдёт, а больше ничего не изменится.

Разрешение на камеру SDK запрашивает сам; в манифест ничего добавлять не нужно.

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

import ru.neurovision.kyc.*

val kyc = registerForActivityResult(NeuroVisionKyc.contract()) { result ->
    when (result) {
        is KycResult.Completed -> result.verdict   // Success | Failed | Suspicious | Expired | Unknown
        KycResult.Cancelled -> Unit                // the user left before the end
        is KycResult.Failed -> result.reason       // CameraDenied | Network | Server | Camera | Config | UnsupportedDevice | Internal
    }
}

kyc.launch(KycRequest(apiHost, schemaId, clientKey))         // a scenario and the key your server minted
kyc.launch(KycRequest(apiHost, KycIdentity.Task(taskId)))    // or a task the server created

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

API

ОбъявлениеЧто это
NeuroVisionKyc.contract()ActivityResultContract<KycRequest, KycResult>, который проводит сессию
NeuroVisionKyc.VERSIONВерсия SDK
KycRequest(apiHost, schemaId, clientKey, clientUser = null, language = null, theme = KycTheme.Auto)Сессия для сценария и ключа, выпущенного вашим сервером
KycRequest(apiHost, identity, clientUser = null, language = null, theme = KycTheme.Auto)Сессия для identity: KycIdentity.Schema(schemaId, clientKey) или KycIdentity.Task(taskId)
clientUserНеобязательно. Идентификатор пользователя в вашей системе, до 36 символов, открытым текстом. Одно значение во всех попытках одного человека объединяет их; персональные данные не передавайте. См. Идентификаторы проверки
languageЯзык интерфейса, ISO 639-1 ("en", "ru", …; "zh-CN" — упрощённый китайский). null — язык сценария, а если его нет — язык устройства. Язык, которого сценарий не предлагает, игнорируется
themeKycTheme.Auto (по выбору сценария, иначе по устройству), Light, Dark
KycResultCompleted(verdict: KycVerdict), Cancelled, Failed(reason: KycFailure, message: String?)

При печати KycIdentity.Schema ключ клиента скрыт (clientKey=<redacted>), поэтому запись запроса в лог не раскрывает ключ.

Что важно знать

  • Одна сессия за раз. Повторный запуск, пока идёт сессия, сразу завершается с Failed(Config, "a KYC session is already running").
  • launchMode. Оставьте у запускающей activity режим standard или singleTop. С singleTask, если пользователь уйдёт из приложения во время сессии и вернётся через иконку на рабочем столе, эта activity выйдет на передний план, Android закроет экран SDK над ней, и результатом будет Cancelled.
  • Экран сессии — портретный.
  • apiHost должен быть https; обычный http допускается только для самого устройства (localhost, 127.x.x.x).
  • Если Android завершит процесс приложения, пока на экране сессия, результат будет потерян.
  • Захват экрана. Экран сессии защищён FLAG_SECURE: на скриншотах, записи экрана, трансляции и в миниатюре списка недавних приложений он чёрный.
  • Релизные сборки. AAR несёт собственные правила R8; в ваш proguard-rules.pro ничего добавлять не нужно.

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

SDK может отправлять продуктовую аналитику в проект PostHog, который указывает ваше приложение в своём манифесте; в самом SDK ключа нет. В AndroidManifest.xml:

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

Без ключа SDK аналитику не отправляет. Держите ключ вне git: плейсхолдер манифеста (manifestPlaceholders), заполняемый из Gradle-свойства или переменной окружения. Что отправляется — Аналитика и приватность.

Приватность

Сессия отправляет на сервер «Нейровижн» фотографию документа, фото и видео проверки liveness, а также сведения об устройстве (модель, ОС, язык, часовой пояс, экран) вместе с признаками эмулятора и вмешательства — для предотвращения мошенничества. Укажите их в форме Data safety своего приложения — см. Аналитика и приватность.