deepidsdk_flutter 1.0.0
deepidsdk_flutter: ^1.0.0 copied to clipboard
Flutter plugin for the DeepID SDK (Android + iOS). Provides SIM binding, device enrollment, and fraud detection capabilities.
1.0.0 #
Initial release of deepidsdk_flutter.
Features #
DeepId.initialize(appKey:, appSecret:, onEnrollment:, onEnrollmentError:, enrollmentTimeout:)— initializes the native SDK and kicks off background device enrollment. Returns once the SDK is constructed (does not wait for enrollment to complete). PassonEnrollmenthere or callDeepId.onEnrollment()separately to be notified whendeepId+sessionIdare ready.DeepId.onEnrollment(onSuccess:, onError:, timeout:)— callback-driven enrollment listener. Fires exactly once when both identifiers are available, or delivers aDeepIdExceptionon timeout or failure.DeepId.startSimBinding({phoneNumber})— presents the native SIM binding sheet (Android: Jetpack Compose Activity; iOS: SwiftUI page sheet). Awaits user confirmation and carrier verification, then returns aSimBindingResult.DeepId.isInitialized— async getter;trueafter a successfulinitialize()call.DeepId.deepId/DeepId.sessionId— synchronous accessors populated after the enrollment callback fires.
Types #
EnrollmentResult— carriesdeepIdandsessionIdfrom a completed enrollment.SimBindingResult— carriessuccess,deepId,sessionId,mobile, andmessagefrom a completed SIM binding flow.DeepIdException— typed exception with aDeepIdErrorCodeand a human-readablemessage. Thrown byinitialize()andstartSimBinding(), and passed toonEnrollmentError.DeepIdErrorCode— exhaustive enum covering all failure modes:notInitialized,invalidAppKey,invalidAppSecret,initFailed,enrollmentTimeout,enrollmentNotComplete,simBindingFailed,userCancelled, and more.
Platform support #
| Platform | Minimum version |
|---|---|
| Android | API 21 (Android 5.0) |
| iOS | 13.0 |
Notes #
- The native SDK binaries (Android AAR and iOS xcframework) are distributed
separately by DeepID and are not bundled in this package. See the
README.mdPrerequisites section for placement instructions. - On Android,
READ_PHONE_STATEandSEND_SMSare dangerous permissions that must be granted at runtime before callingstartSimBinding(). - On iOS, add
NSMotionUsageDescriptionto yourInfo.plistbefore submitting to the App Store.