iOS SDK NeuroVisionKyc (Swift, SwiftUI) проводит сессию в собственном полноэкранном контроллере или SwiftUI-view и возвращает результат в замыкание.
Требования
| iOS |
| Xcode |
| Установка |
Установка
Пока SDK не опубликован, он поставляется локальным Swift-пакетом в пакете SDK (sdk/ios/NeuroVisionKyc/ — папка с Package.swift и Frameworks/). Скопируйте её в свой проект, затем в Xcode: File → Add Package Dependencies… → Add Local…, выберите эту папку и добавьте библиотеку NeuroVisionKyc в target приложения.
С XcodeGen:
packages:
NeuroVisionKyc:
path: third_party/NeuroVisionKyc
targets:
App:
dependencies:
- package: NeuroVisionKyc Фреймворк — бинарный, для устройств (arm64) и симулятора (arm64, x86_64). После публикации SDK локальный пакет заменится URL пакета, а больше ничего не изменится.
В Info.plist приложения нужен текст об использовании камеры — без него iOS завершит приложение при первом обращении к камере:
<key>NSCameraUsageDescription</key>
<string>The camera photographs your document and films the liveness check.</string> Использование
UIKit:
import NeuroVisionKyc
let request = KycRequest(apiHost: apiHost, schemaId: schemaId, clientKey: clientKey)
// or KycRequest(apiHost: apiHost, identity: .task(taskId: taskId)) for a task the server created
let screen = NeuroVisionKyc.makeViewController(request: request) { result in
controller.dismiss(animated: true)
switch result {
case .completed(let verdict): print(verdict) // success, failed, suspicious, expired, unknown
case .cancelled: break // the user left before the end
case .failed(let reason, let message): print(reason, message ?? "")
@unknown default: break
}
}
controller.present(screen, animated: true) SwiftUI:
.fullScreenCover(isPresented: $running) {
NeuroVisionKycView(request: request) { result in
running = false
// handle result
}
} NeuroVisionKycView открывает сессию при первом появлении и завершает её с .cancelled, если приложение уберёт view до конца сессии.
Что означает каждый результат и что показать пользователю — Результаты. Откуда берутся apiHost, schemaId, clientKey и taskId — Интеграция с сервером.
API
| Объявление | Что это |
|---|---|
NeuroVisionKyc.makeViewController(request:onResult:) | Полноэкранный UIViewController, который проводит сессию; показываете его вы |
NeuroVisionKycView(request:onResult:) | Та же сессия в виде SwiftUI-view |
NeuroVisionKyc.version | Версия SDK |
KycRequest(apiHost:schemaId:clientKey:clientUser:language:theme:) | Сессия для сценария и ключа, выпущенного вашим сервером |
KycRequest(apiHost:identity:clientUser:language:theme:) | Сессия для identity: .schema(schemaId:clientKey:) или .task(taskId:) |
apiHost | URL |
clientUser | Необязательно. Идентификатор пользователя в вашей системе, до 36 символов, открытым текстом. Одно значение во всех попытках одного человека объединяет их; персональные данные не передавайте. См. Идентификаторы проверки |
language | Язык интерфейса, ISO 639-1 ("en", "ru", …; "zh-CN" — упрощённый китайский). nil — язык сценария, а если его нет — язык устройства. Язык, которого сценарий не предлагает, игнорируется |
theme | .auto (по выбору сценария, иначе по устройству), .light, .dark |
KycResult | .completed(KycVerdict), .cancelled, .failed(KycFailure, message: String?) |
При печати KycIdentity или KycRequest ключ клиента скрыт, поэтому запись запроса в лог не раскрывает ключ.
Что важно знать
onResultвызывается один раз, на главной очереди; закрыть контроллер — ваша задача. Если контроллер закрыт до конца сессии, сессия завершается с.cancelled.- Перечисления SDK не заморожены (not frozen): в новой версии может появиться новый case, поэтому в
switchпо ним нужен@unknown default. - Одна сессия за раз. Вторая сессия, пока идёт первая, сразу завершается с
.failed(.config, "a KYC session is already running"). - Экран сессии — полноэкранный и портретный.
apiHostдолжен бытьhttps; обычныйhttpдопускается только для самого устройства (localhost).- SDK работает и на симуляторе, но камеры у симулятора нет: проводите сессии на устройстве.
- iOS 15 – 16.3. Сессия работает, с небольшими отличиями в вёрстке: нижние панели занимают всю высоту, принимаемые документы стоят по одному в ряд, а индикатор «домой» остаётся видимым во время проверки liveness.
Аналитика (по желанию)
SDK может отправлять продуктовую аналитику в проект PostHog, который указывает ваше приложение в своём Info.plist; в самом SDK ключа нет:
<key>NeuroVisionKycPostHogKey</key>
<string>phc_…</string>
<key>NeuroVisionKycPostHogHost</key>
<string>https://us.i.posthog.com</string> Без ключа SDK аналитику не отправляет. Держите ключ вне git: $(KYC_POSTHOG_KEY) в Info.plist, значение — из .xcconfig, который не попадает в git. Что отправляется — Аналитика и приватность.
Приватность
Фреймворк несёт свой манифест приватности (PrivacyInfo.xcprivacy): Xcode объединяет его с отчётом о приватности вашего приложения (Product → Archive → Generate Privacy Report), по которому вы заполняете privacy label в App Store. Сессия отправляет на сервер «Нейровижн» фотографию документа, фото и видео проверки liveness и сведения об устройстве вместе с признаками симулятора и вмешательства — для предотвращения мошенничества; см. Аналитика и приватность.