Быстрый старт

От пустого проекта до первой проверки, ничего не пропуская: сначала разрешаем приложение на сервере, потом создаём приложение на Android, iOS, Flutter или React Native — инструкции для каждой платформы ниже на этой странице. В конце у вас приложение с одной кнопкой Start KYC, которая проводит настоящую проверку и показывает её результат.

Подробности по каждой платформе: Android, iOS, Flutter, React Native.

Шаг 0. Что понадобится

ЧтоГде взять
Пакет SDKЗапросите через поддержку. Ниже <пакет> — папка, в которую вы его распаковали
apiHost — адрес KYC APIОт «Нейровижн», для тестового и для боевого сервера
ID сценария и его секретный ключЛичный кабинет, раздел «KYC/AML»
ТелефонAndroid (arm64 или armeabi-v7a; эмулятор x86_64 не подходит) или iPhone (у симулятора нет камеры)

Шаг 1. Разрешите своё приложение на сервере

Сервер «Нейровижн» пускает только те адреса (origins), которые есть в его списке. Сайт приходит со своим доменом, а приложение — со своим Application ID (Android) или Bundle Identifier (iOS).

Временно адрес приложения записывается с префиксом https://: https:// + id приложения. Позже для приложений появится отдельный тип записи — мы сообщим.

1. Узнайте id своего приложения:

ПлатформаГде написан id
Android, Flutter (Android), React Native (Android)applicationId в app/build.gradle.kts или android/app/build.gradle
iOS, Flutter (iOS), React Native (iOS)Xcode → target приложения → General → Bundle Identifier

2. Составьте адрес: https:// + id, ровно как написано, без / в конце и без пробелов.

idАдрес для списка
com.example.mykychttps://com.example.mykyc
com.example.my_kychttps://com.example.my_kyc

3. Добавьте адрес в список разрешённых origins в личном кабинете: «Доступ» → «Разрешённые домены», туда же, где домены сайта. Это можно сделать самостоятельно.

4. Каждая сборка — свой адрес. Если у debug-сборки есть суффикс (applicationIdSuffix = ".debug" → com.example.mykyc.debug) или у iOS-приложения другой bundle id, чем у Android, — внесите каждый.

Если адреса нет в списке, проверка сразу останавливается с сообщением «Проверка недоступна на этом домене. Обратитесь к администратору сайта.» Увидели его — вернитесь к этому шагу.

Шаг 2. Значения для первой проверки

Для первой проверки нужны два значения:

ЗначениеГде взять
schemaIdID сценария из раздела «KYC/AML» личного кабинета
clientKeyЗашифруйте любое тестовое значение, например test-1, секретным ключом сценария — готовый код на Node.js и Python есть на странице Интеграция с сервером, раздел «Выпуск ключа клиента»

Для каждой следующей проверки берите новое значение — test-2, test-3 и так далее: один clientKey — одна сессия, и повторный запуск с ним откроет прежнюю.

Для первой проверки эти значения можно вписать прямо в код. В настоящем приложении schemaId и зашифрованный clientKey присылает ваш сервер, а секрет сценария в приложение не попадает.


Android (Kotlin)

Нужны свежая Android Studio и JDK 17.

A1. Создайте проект

  1. Android Studio → New Project → Empty Activity → Next.
  2. Name: MyKyc, Package name: com.example.mykyc, Language: Kotlin, Minimum SDK: API 26, Build configuration language: Kotlin DSL → Finish.

A2. Положите SDK рядом с проектом

Скопируйте папку <пакет>/sdk/android/maven в корень проекта под именем third_party/neurovision-maven:

MyKyc/
├── app/
├── third_party/
│   └── neurovision-maven/
│       └── ru/neurovision/kyc/kyc-sdk/0.6.2/…
└── settings.gradle.kts

A3. settings.gradle.kts — откуда брать SDK

Найдите блок dependencyResolutionManagement и добавьте maven { … } первым в repositories:

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

A4. app/build.gradle.kts — подключите SDK

android {
    defaultConfig {
        applicationId = "com.example.mykyc"   // the id you allowed in step 1
        minSdk = 26
        // …
    }
}

dependencies {
    implementation("ru.neurovision.kyc:kyc-sdk:0.6.2")
    // … the rest Android Studio created
}

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

A5. MainActivity.kt — кнопка и результат

Замените содержимое app/src/main/java/com/example/mykyc/MainActivity.kt:

package com.example.mykyc

import ru.neurovision.kyc.NeuroVisionKyc
import ru.neurovision.kyc.KycRequest
import ru.neurovision.kyc.KycResult
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Button
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.material3.Text
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.setValue
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp

// Values from step 2. In a real app your server sends schemaId and the encrypted clientKey.
private const val API_HOST = "PASTE_API_HOST"   // the address NeuroVision sent you
private const val SCHEMA_ID = "PASTE_SCHEMA_ID"
private const val CLIENT_KEY = "PASTE_CLIENT_KEY"

class MainActivity : ComponentActivity() {
    private var status by mutableStateOf("Press the button")

    private val kyc = registerForActivityResult(NeuroVisionKyc.contract()) { result ->
        status = when (result) {
            is KycResult.Completed -> "Completed: ${result.verdict}"   // Success | Failed | Suspicious | Expired | Unknown
            KycResult.Cancelled -> "Cancelled"                         // the user left before the end
            is KycResult.Failed -> "Failed: ${result.reason} ${result.message.orEmpty()}"
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            MaterialTheme {
                Surface(Modifier.fillMaxSize()) {
                    Column(
                        Modifier.padding(24.dp),
                        verticalArrangement = Arrangement.spacedBy(16.dp),
                        horizontalAlignment = Alignment.CenterHorizontally,
                    ) {
                        Button(onClick = { kyc.launch(KycRequest(API_HOST, SCHEMA_ID, CLIENT_KEY)) }) {
                            Text("Start KYC")
                        }
                        Text(status)
                    }
                }
            }
        }
    }
}

Проверка по задаче (taskId)? Тогда вместо KycRequest(API_HOST, SCHEMA_ID, CLIENT_KEY) используйте KycRequest(API_HOST, KycIdentity.Task("PASTE_TASK_ID")) и import ru.neurovision.kyc.KycIdentity.

A6. Запустите

Подключите телефон по USB (включена «Отладка по USB»), выберите его вверху Android Studio и нажмите Run ▶. Нажмите Start KYC, пройдите проверку — внизу появится результат, например Completed: Success.


iOS (SwiftUI)

Нужны Xcode 26+ и iPhone с iOS 15 или новее.

I1. Создайте проект

  1. Xcode → File → New → Project… → iOS → App → Next.
  2. Product Name: MyKyc, Organization Identifier: com.example, Interface: SwiftUI, Language: Swift → Next.
  3. Target MyKyc → General → Minimum Deployments: iOS 15.0. Bundle Identifier (com.example.MyKyc) — это id, который нужно разрешить на шаге 1: https://com.example.MyKyc.
  4. Signing & Capabilities: выберите свою команду (Team).

I2. Подключите SDK

  1. Скопируйте <пакет>/sdk/ios/NeuroVisionKyc (папку с Package.swift и Frameworks/) в папку проекта под именем third_party/NeuroVisionKyc.
  2. File → Add Package Dependencies… → Add Local…, выберите third_party/NeuroVisionKyc и добавьте библиотеку NeuroVisionKyc в target MyKyc.

I3. Текст о камере

Target MyKyc → Info → добавьте ключ Privacy — Camera Usage Description (NSCameraUsageDescription) с текстом, например: The camera photographs your document and films the liveness check. Без него iOS завершит приложение в момент открытия камеры.

I4. ContentView.swift — кнопка и результат

Замените файл целиком:

import NeuroVisionKyc
import SwiftUI

// Values from step 2. In a real app your server sends schemaId and the encrypted clientKey.
private let apiHost = URL(string: "PASTE_API_HOST")!   // the address NeuroVision sent you
private let schemaId = "PASTE_SCHEMA_ID"
private let clientKey = "PASTE_CLIENT_KEY"

struct ContentView: View {
    @State private var running = false
    @State private var status = "Press the button"

    var body: some View {
        VStack(spacing: 16) {
            Button("Start KYC") { running = true }
                .buttonStyle(.borderedProminent)
            Text(status)
        }
        .fullScreenCover(isPresented: $running) {
            NeuroVisionKycView(request: KycRequest(apiHost: apiHost, schemaId: schemaId, clientKey: clientKey)) { result in
                running = false
                switch result {
                case .completed(let verdict): status = "Completed: (verdict.rawValue)"
                case .cancelled: status = "Cancelled"
                case .failed(let reason, let message): status = "Failed: (reason.rawValue) (message ?? "")"
                @unknown default: status = "Unknown result"
                }
            }
        }
    }
}

Проверка по задаче (taskId)? Тогда используйте KycRequest(apiHost: apiHost, identity: .task(taskId: "PASTE_TASK_ID")).

I5. Запустите

Подключите iPhone, выберите его вверху Xcode и нажмите Run ▶. Нажмите Start KYC, пройдите проверку — под кнопкой появится результат.


Flutter

Нужны Flutter 3.47+, Android Studio (Android SDK), для iOS — Xcode 26+.

F1. Создайте проект

flutter create --org com.example --platforms android,ios my_kyc
cd my_kyc

Id получатся такие — их и разрешайте на шаге 1:

idАдрес для списка
Androidcom.example.my_kyc
iOScom.example.myKyc

F2. Положите SDK в проект

Скопируйте из пакета SDK:

ОткудаКуда
<пакет>/sdk/flutter/neurovision_kycmy_kyc/third_party/neurovision_kyc
<пакет>/sdk/android/mavenmy_kyc/third_party/neurovision-maven

F3. pubspec.yaml — подключите плагин

dependencies:
  flutter:
    sdk: flutter
  neurovision_kyc:
    path: third_party/neurovision_kyc

Затем выполните flutter pub get.

F4. Android: репозиторий SDK и minSdk

android/build.gradle.kts — в allprojects { repositories { … } } добавьте maven { … } первым:

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

android/app/build.gradle.kts — замените minSdk = flutter.minSdkVersion на:

        minSdk = 26

F5. iOS: версия iOS и текст о камере

1. open ios/Runner.xcworkspace → target Runner → General → Minimum Deployments: 15.0. Если в проекте есть ios/Podfile, раскомментируйте в нём строку platform и поставьте platform :ios, '15.0'.

2. ios/Runner/Info.plist — внутри <dict>:

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

3. Там же, в Signing & Capabilities, выберите свою команду (Team).

F6. lib/main.dart — кнопка и результат

Замените файл целиком:

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

// Values from step 2. In a real app your server sends schemaId and the encrypted clientKey.
const apiHost = 'PASTE_API_HOST'; // the address NeuroVision sent you
const schemaId = 'PASTE_SCHEMA_ID';
const clientKey = 'PASTE_CLIENT_KEY';

void main() => runApp(const MaterialApp(home: KycPage()));

class KycPage extends StatefulWidget {
  const KycPage({super.key});

  @override
  State<KycPage> createState() => _KycPageState();
}

class _KycPageState extends State<KycPage> {
  String _status = 'Press the button';

  Future<void> _start() async {
    final result = await NeuroVisionKyc.start(
      const KycRequest(apiHost: apiHost, schemaId: schemaId, clientKey: clientKey),
    );
    // or: KycRequest.task(apiHost: apiHost, taskId: 'PASTE_TASK_ID')
    setState(() {
      _status = switch (result) {
        KycCompleted(:final verdict) => 'Completed: $verdict',
        KycCancelled() => 'Cancelled',
        KycFailed(:final reason, :final message) => 'Failed: $reason ${message ?? ''}',
      };
    });
  }

  @override
  Widget build(BuildContext context) => Scaffold(
        body: Center(
          child: Column(mainAxisSize: MainAxisSize.min, children: [
            FilledButton(onPressed: _start, child: const Text('Start KYC')),
            const SizedBox(height: 16),
            Text(_status),
          ]),
        ),
      );
}

F7. Запустите

flutter devices          # the phone must be listed
flutter run              # an iPhone: flutter run -d <iPhone id>

Нажмите Start KYC, пройдите проверку — под кнопкой появится результат.


React Native

Нужны Node 22.11+, JDK 17, Android Studio (Android SDK platform 36+), для iOS — Xcode 26+ и CocoaPods. Expo не подходит: нужен «голый» React Native.

R1. Создайте проект

npx @react-native-community/cli@latest init MyKyc --version 0.87.1
cd MyKyc

Id получатся такие — их и разрешайте на шаге 1 (iOS id можно сменить в Xcode → General → Bundle Identifier):

idАдрес для списка
Androidcom.mykyc
iOSorg.reactjs.native.example.MyKyc

R2. Положите SDK в проект и установите пакет

Скопируйте из пакета SDK:

ОткудаКуда
<пакет>/sdk/react-native/neurovision-react-native-kyc-0.6.2.tgzMyKyc/third_party/neurovision-react-native-kyc-0.6.2.tgz
<пакет>/sdk/android/mavenMyKyc/third_party/neurovision-maven
npm install ./third_party/neurovision-react-native-kyc-0.6.2.tgz

R3. Android: репозиторий SDK, minSdk, launchMode

android/build.gradle:

1. В buildscript { ext { … } } поставьте minSdkVersion = 26.

2. В конец файла добавьте:

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

android/app/src/main/AndroidManifest.xml — у <activity android:name=".MainActivity" …> замените android:launchMode="singleTask" на android:launchMode="singleTop". С singleTask проверка теряется, если пользователь свернёт приложение и вернётся в него через иконку.

R4. iOS: текст о камере, pods

1. ios/MyKyc/Info.plist — внутри <dict>:

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

2. cd ios && pod install && cd ..

3. open ios/MyKyc.xcworkspace → target MyKyc → Signing & Capabilities → своя команда (Team).

R5. App.tsx — кнопка и результат

Замените файл целиком:

import { useState } from 'react';
import { Button, StyleSheet, Text, View } from 'react-native';
import { NeuroVisionKyc, KycError } from '@neurovision/react-native-kyc';

// Values from step 2. In a real app your server sends schemaId and the encrypted clientKey.
const apiHost = 'PASTE_API_HOST'; // the address NeuroVision sent you
const schemaId = 'PASTE_SCHEMA_ID';
const clientKey = 'PASTE_CLIENT_KEY';

export default function App() {
  const [status, setStatus] = useState('Press the button');

  async function start() {
    try {
      const result = await NeuroVisionKyc.start({ apiHost, schemaId, clientKey });
      // or: NeuroVisionKyc.start({ apiHost, taskId: 'PASTE_TASK_ID' })
      switch (result.kind) {
        case 'completed':
          setStatus(`Completed: ${result.verdict}`);
          break;
        case 'cancelled':
          setStatus('Cancelled');
          break;
        case 'failed':
          setStatus(`Failed: ${result.reason} ${result.message ?? ''}`);
          break;
      }
    } catch (e) {
      setStatus(e instanceof KycError ? `Misuse: ${e.code}` : String(e));
    }
  }

  return (
    <View style={styles.screen}>
      <Button title="Start KYC" onPress={start} />
      <Text style={styles.status}>{status}</Text>
    </View>
  );
}

const styles = StyleSheet.create({
  screen: { flex: 1, alignItems: 'center', justifyContent: 'center' },
  status: { marginTop: 16 },
});

R6. Запустите

npm start                          # Metro — keep this terminal open
npx react-native run-android       # in a second terminal; or: npx react-native run-ios --device

Нажмите Start KYC, пройдите проверку — под кнопкой появится результат.


Что-то пошло не так?

См. Решение проблем. Что означает каждый результат и что показать пользователю — Результаты.