This document introduces the custom capabilities of the eKYC SDK (global edition).
I. Custom UI
Customizing layout
The eKYC SDK supports customizing the UI, primarily by configuring parameters using the AuthUiConfig settings. The UI layout can be customized by specifying the Layout resId.
The layout shown in the following figure is the default layout.
The default layout is shown in the figure above. The positions of all controls in the figure can be adjusted by modifying the Layout.xml file. For specific details, please refer to the demo_huiyan_fragment_authing.XML file in the demo.
Note:
In the file demo_huiyan_fragment_authing.xml, please do not modify the ViewType and the corresponding android:id values, as they are involved in binding interface events.
In the previous section, creation of custom UI layouts has been described. This section will focus on how to bind events to the controls that are added to these custom layouts, in order to meet your various needs during actual use.
When the identity verification interface is created, the “onMainViewCreate(View authView)” method of “HuiYanAuthEventCallBack” will be called. When the identity verification interface is about to be destroyed, the “onMainViewDestroy()” method will be called back, allowing you to customize the handling logic according to the corresponding lifecycle stage.
// Configure the callback monitoring for key events associated with eKYC.
Based on the callback mechanisms of “onMainViewCreate” and “onMainViewDestroy,” you can complete the event binding for any newly added UI controls to achieve the desired effects.
II. Custom Prompt and Language
Customizing prompt
If you want to modify a prompt or add a language file, follow the instructions below. The eKYC SDK provides a translation file hy_customer_string.xml , which contains all the configuration text files that can be modified externally by the SDK.
1. Open the main module (the module that integrates the SDK) of the project.
2. Add the hy_customer_string.xml file to the corresponding language folder.
3. Modify the text content that needs to be customized.
4. After packaging, the modified content will automatically replace the original text.
Add New Languages
To add a new language to the file, you need to perform the following two steps:
1. Add a folder for the corresponding language within the main module (the module that integrates the SDK) project.
2. Copy hy_customer_string.xml to the folder corresponding to the target language, and modify the value content accordingly.
3. Simply specify the corresponding language code in the code (taking Thai as an example).
Liveness face comparison offers two advanced security modes: Enhance Mode and Plus Mode. These modes enhance the security of liveness detection by combining device-based risk control technologies. To enable these modes, corresponding settings must be made during both the SDK configuration process and the token acquisition phase.
SDK configuration requirements
Whether in Enhance Mode or Plus Mode, it is necessary to enable device-based risk control functionality within the SDK and configure the corresponding risk control license file.
// Set the device risk control license file (which must be placed in the assets directory).
huiYanOsConfig.setRiskLicense("turing.lic");
// Enable the device-based risk control capabilities.
huiYanOsConfig.setOpenCheckRiskMode(true);
Note:
The device-based risk control license is a separate file from the identity verification authorization license. It must be applied for separately.
Token acquisition configuration
When calling the “GetFaceIdTokenIntl” API to obtain the business token, it is necessary to specify whether to use the Enhance mode or the Plus mode by setting the “SdkVersion” parameter.
Enhance mode: Set the corresponding “SdkVersion” value.
Plus mode: Set the corresponding “SdkVersion” value.
1. Set the corresponding “SdkVersion” parameter when obtaining the Token.
2. Enable device-based risk control functionality in the SDK configuration.
3. Input the configured Token when calling the “startHuiYanAuth” method.
4. The SDK will automatically enable the appropriate security level based on the information contained in the Token.
Note:
Please ensure that the settings for both SDK configuration and Token acquisition are exactly identical; otherwise, the mode may not be enabled.
IV.FAQs
1.After integrating SDK, why the error “Invoke-customs are only supported starting with Android O (–min-api 26)” occurs. The following configuration needs to be added to the “build.gradle” file:
// Java version supports 1.8.
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
2.If the integrator uses AndResGuard’s obfuscation tool, obfuscation configuration can be added accordingly.
// for HuiYanSDK
"R.string.ocr_*",
"R.string.rst_*",
"R.string.net_*",
"R.string.msg_*",
"R.string.fl_*",
3.For certain devices running older versions of Android X, errors such as “android.content.res.Resources$NotFoundException: from XML type XML resource ID #0x7f0800c3” may occur. In such cases, consider adding dependencies for vector graphics.
