aiyl_myid
Aiyl SDK flutter plugin.
Table of contents
Android SDK: 1.1.7
iOS SDK: 1.1.1
Project adjustments
iOS
Update your iOS configuration files
Change ios/Podfile to use version 14:
platform :ios, '14.0'
Add descriptions for camera permission to ios/YourProjectName/Info.plist:
<plist version="1.0">
<dict>
<!-- Add these two elements: -->
<key>NSCameraUsageDescription</key>
<string>Required for document and facial capture</string>
<!-- ... -->
</dict>
</plist>
Usage
var result = await AiylClient.start(
config: AiylConfig(
entryMode: AiylEntryMode.selfieOnly,
locale: AiylLocale.english
),
);
Parameters details:
| Method | Notes | Default |
|---|---|---|
entryMode |
To set a specific entry mode | AiylEntryMode.fullIdent |
locale |
To set a specific locale | AiylLocale.kyrgyz |
previewSettings |
To set a specific preview settings | null |
faceCropExpandPercent |
To set the face crop expand percent | 0.5 |
requireDocumentDetectionOnSelfieStage |
To require document detection on selfie stage | true |
soundGuides |
Sound guides provide auditory feedback to the user | true |
timeout |
To set a timeout duration (in seconds) for the scanning process | 120 seconds |
SDK error codes
The error code in the following list may appear during the call of SDK. The list below is for your reference.
| Code | Error message |
|---|---|
| 101 | Unexpected error |
| 102 | Camera access denied |
Getting Started with Flutter plugins
This project is a starting point for a Flutter plug-in package, a specialized package that includes platform-specific implementation code for Android and/or iOS.
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.