tencent cloud

The main API classes used in the eKYC SDK for Android are EkycHySdk, EkycHyConfig, and EkycHyCallBack. Specific APIs in these classes are described as below.

EkycHySdk

EkycHySdk is a class of external APIs for the eKYC SDK. Main logic operations are completed with this class.

init()

public static void init(Context context)

Feature:

It is an API for initializing the ​eKYC SDK.

Input parameters:

release()

public static void release() 

Feature:

It is an API for releasing eKYC SDK resources.

startEkycCheck()

public static void startEkycCheck(final String ekycToken, EkycHyConfig ekycHyConfig,
          EkycHyCallBack ekycHyCallBack)

Feature:

It is a function for starting the eKYC process.

Input parameters:

EkycHyConfig

EkycHyConfig is the configuration entity class used during the eKYC SDK startup, which mainly covers the following attributes:

OcrRegionType

This API is used to detect the type of the document.
| Enumerated Value | Description |
|---|---|
|HK| Hong Kong (China) - identity card |
|ML| Malaysia - identity card |
|PhilippinesDrivingLicense| Philippines - driver's license |
|PhilippinesVoteID| Philippines - VoteID |

LanguageStyle

This API provides the language configuration information of the default eKYC interface.

OcrUiConfig

EkycHyCallBack

This is the listener class for receiving the eKYC process results.

/**
* The result callback class for eKYC
*/
public interface EkycHyCallBack {
   /**
   * Result information on successful recognition
   *
   * @param result: Result data
   */
  void onSuccess(EkycHyResult result);
   /**
   * Information of eKYC process failure
   *
   * @param errorCode: Error code
   @param errorMsg: Error message
   * @param ekycToken: The token of this process
   */
  void onFail(int errorCode, String errorMsg, String ekycToken);
}

Here EkycHyResult is the result object returned after a successful process.

EkycHyResult

EkycHyResult is the result object returned after the eKYC process succeeds.

Error codes and descriptions