Oʻrnatish
Talablar: Dart 3.5+, Flutter 3.24+, Android minSdk 24, iOS 13.
- kyc_flutter.zip ni yuklab oling va loyihangiz ichiga oching, masalan
packages/kyc_flutterpapkasiga. pubspec.yamlga path bogʻliqligini qoʻshing:
dependencies:
kyc_flutter:
path: packages/kyc_flutter
flutter pub getni ishga tushiring.
Paket hali pub.dev da yoʻq. Zip ichida quyidagi sozlamalarning barchasi qilingan example/ ilovasi bor.
Ruxsatlar
SDK kamerani avval tizim orqali soʻraydi, keyin uni jarayonga beradi. Foydalanuvchi rad etsa, jarayon oʻz xabarini koʻrsatadi.
Android — android/app/src/main/AndroidManifest.xml:
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
iOS — ios/Runner/Info.plist:
<key>NSCameraUsageDescription</key>
<string>The camera is used to photograph your document and take a selfie for identity verification.</string>
va ios/Podfile da (post_install ichida) kamera ruxsatini yoqing:
target.build_configurations.each do |config|
config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'PERMISSION_CAMERA=1']
end
Podfile boshida platform :ios, '13.0' boʻlishi kerak.
Jarayonni boshlash
Backendingiz sessiya yaratadi (POST /applicants/{id}/sessions) va ilovaga faqat uning token ini yuboradi. url ni emas, token ni bering.
API maxfiy kalitini hech qachon ilovaga qoʻymang. Uni ilova paketidan istalgan odam chiqarib olishi mumkin.
import 'package:kyc_flutter/kyc_flutter.dart';
Future<void> verify(BuildContext context) async {
final token = await myBackend.createKycSession(); // session token
final result = await KycFlow.start(
context,
token: token,
locale: 'uz', // uz | ru | en, optional
);
if (result.isCancelled) {
// Closed before a decision. result.errorCode: link_invalid, session_expired, network, …
return;
}
switch (result.decision!) {
case KycDecision.green:
showMessage('Thank you! We are confirming your verification.');
case KycDecision.onHold:
showMessage('Your documents are under review.');
case KycDecision.red:
// decisionType: 'retry' — can try again with a new session; 'final' — cannot
showMessage('Verification failed: ${result.rejectLabels.join(', ')}');
}
// Unlock features only after your backend confirms the decision.
await myBackend.refreshKycStatus();
}
KycFlow.start toʻliq ekranli oynani ochadi va Future<KycResult> qaytaradi. Natija hech qachon null boʻlmaydi: foydalanuvchi ekranni yopsa, bekor qilingan natija olasiz. Natija ekranidan 3 soniya keyin oyna oʻzi yopiladi.
| Parametr | Standart | Tavsif |
|---|---|---|
token |
majburiy | Sessiya token i |
baseUrl |
https://kyc.goxost.net |
HTTPS boʻlishi shart |
locale |
arizachining locale i |
uz, ru yoki en |
title |
locale tilida «Shaxsni tasdiqlash» (berilmasa inglizcha) |
Yuqori panel sarlavhasi |
closeDelay |
3 soniya | Natija ekrani yopilishdan oldin qancha turishi |
onEvent |
— | Har bir hodisada chaqiriladi (quyida) |
readChip |
true |
Senariy talab qilsa, hujjatning elektron tekshiruvini bajarish |
KycResult:
| Maydon | Turi | Tavsif |
|---|---|---|
decision |
KycDecision? |
green, red, onHold; bekor qilinganda null. .code GREEN, RED, ON_HOLD ni beradi |
decisionType |
String? |
RED uchun final yoki retry, aks holda odatda null |
rejectLabels |
List<String> |
Sabab kodlari, Xatolar va belgilar bobiga qarang |
errorCode |
String? |
Jarayon qarorsiz yopilganda oxirgi xato |
isCancelled |
bool |
Qaror boʻlmasa true |
Ilovadagi natija faqat interfeys uchun. Yakuniy qarorni backendingizda webhookdan yoki GET /verifications/{id} dan oling.
Oʻz ekraningizga joylash
Jarayonni oʻz maketingiz ichiga qoʻyish uchun KycView dan foydalaning:
SizedBox(
height: 640,
child: KycView(
key: ValueKey(token), // a new key restarts the flow with a new token
token: token,
locale: 'ru',
onStep: (step) {}, // KycStep.consent, document, liveness, processing, handoff
onComplete: (result) {}, // KycResult
onError: (code) {}, // link_invalid, session_expired, network, http_<status>, …
onCancel: () {}, // system back before a result
onEvent: (event) {}, // every event, including ready and resize
),
)
KycView ga cheklangan oʻlcham kerak — masalan Expanded, SizedBox yoki Scaffold tanasi ichida. U hujjatning elektron tekshiruvini bajarmaydi; buning uchun KycFlow.start dan foydalaning.
Hodisalar (onEvent): KycReadyEvent, KycStepEvent, KycCompleteEvent, KycErrorEvent, KycResizeEvent — kyc.js dagi hodisalarning oʻzi.
Hujjatning elektron tekshiruvi
Senariyda hujjatning elektron tekshiruvi optional yoki required qilib qoʻyilgan boʻlsa (panel → Sozlamalar), KycFlow.start uni suratlardan keyin bajaradi: koʻrsatma ekrani, jarayon holati, qayta urinish va senariy ruxsat bersa — oʻtkazib yuborish tugmasi. Bu imkoniyati yoʻq telefonlar qadamni avtomatik oʻtkazib yuboradi. Oʻchirish uchun readChip: false bering. Bu qadam maʼlumotlari qurilmaga yozilmaydi.
Android — manifestga qoʻshing. required="false" ilovani bu imkoniyati yoʻq telefonlarga ham oʻrnatish imkonini saqlaydi:
<uses-permission android:name="android.permission.NFC" />
<uses-feature android:name="android.hardware.nfc" android:required="false" />
iOS (iPhone 7 yoki yangiroq) — ios/Runner/Info.plist ga qoʻshing:
<key>NFCReaderUsageDescription</key>
<string>Used to check your identity document electronically.</string>
<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
<string>A0000002471001</string>
</array>
Soʻng Xcode → Signing & Capabilities da Near Field Communication Tag Reading ni qoʻshing. U ios/Runner/Runner.entitlements faylini yozadi:
<key>com.apple.developer.nfc.readersession.formats</key>
<array>
<string>TAG</string>
</array>
App ID da shu capability yoqilgan boʻlishi kerak. Bu qadam simulyatorda emas, faqat haqiqiy qurilmada ishlaydi.
Veb jarayon va kyc.js hujjatning elektron tekshiruvini bajara olmaydi. Senariyda u required boʻlib, zaxira yoʻl ruxsat etilmagan boʻlsa, vebdan topshirish 409 nfc_required bilan tugaydi — veb foydalanuvchilar uchun alohida senariy ishlating.
Muammolarni hal qilish
| Muammo | Yechim |
|---|---|
Boshlashda ArgumentError |
url ni emas, sessiya token ini (eyJ bilan boshlanadi) bering; baseUrl HTTPS boʻlishi shart |
| iOS da kamera qora | NSCameraUsageDescription va Podfile dagi PERMISSION_CAMERA=1 ni tekshiring, keyin pod install |
| Android da kamera ochilmaydi | Manifestdagi CAMERA ruxsatini va foydalanuvchi uni tizim sozlamalarida ruxsat berganini tekshiring |
errorCode: link_invalid yoki session_expired |
Sessiya ishlatilgan, almashtirilgan yoki muddati tugagan — har bir urinish uchun yangi sessiya yarating |
KycView boʻsh yoki maket xatosini beradi |
Unga cheklangan balandlik bering |
| Elektron tekshiruv qadami yoʻq | Senariyda u off, telefonda bu imkoniyat yoʻq, readChip false yoki siz KycView ishlatgansiz |
| iOS da elektron tekshiruv ishlamaydi | select-identifiers yozuvini, capability ni va App ID da u yoqilganini tekshiring |