- 产品简介
- 购买指南
- 接入文档
- API 文档
- History
- Introduction
- API Category
- Making API Requests
- Liveness Detection and Face Comparison (Pure API) APIs
- DetectAIFakeFaces (Pure API) APIs
- Liveness Detection and Face Comparison (App SDK) APIs
- eKYC and Liveness Detection and Face Comparison (Mobile HTML5) APIs
- eKYC (App SDK) APIs
- ID Verification (Pure API) APIs
- Other APIs
- Data Types
- Error Codes
- 常见问题
- 联系我们
- 词汇表
- eKYC 政策
- 产品简介
- 购买指南
- 接入文档
- API 文档
- History
- Introduction
- API Category
- Making API Requests
- Liveness Detection and Face Comparison (Pure API) APIs
- DetectAIFakeFaces (Pure API) APIs
- Liveness Detection and Face Comparison (App SDK) APIs
- eKYC and Liveness Detection and Face Comparison (Mobile HTML5) APIs
- eKYC (App SDK) APIs
- ID Verification (Pure API) APIs
- Other APIs
- Data Types
- Error Codes
- 常见问题
- 联系我们
- 词汇表
- eKYC 政策
Android端Identity Verification(App SDK)主要涉及的类主要包含EkycHySdk、EkycHyConfig、EkycHyCallBack这几个主要类型下面对其支持的API做出详细说明。
EkycHySdk
EkycHySdk为Identity Verification(App SDK)的对外接口类，主要逻辑也都是调用此类完成。
API | 功能描述 |
init() | 初始化接口 |
release() | 资源释放接口 |
startEkycCheck() | 启动身份认证Identity Verification检测流程 |
init()
public static void init(Context context)
功能介绍：
Identity Verification(App SDK)的初始化接口。
传入参数:
参数类型 | 参数名称 | 参数含义 |
Context | context | App的上下文信息 |
release()
public static void release()
功能介绍：
Identity Verification(App SDK)资源释放的接口。
startEkycCheck()
public static void startEkycCheck(final String ekycToken, EkycHyConfig ekycHyConfig,EkycHyCallBack ekycHyCallBack)
功能介绍：
启动身份认证Identity Verification检测流程的流程函数。
传入参数：
参数类型 | 参数名称 | 参数含义 |
String | ekycToken | 从服务器端获取的Token值，作为此次流程唯一业务凭证 |
EkycHyConfig | ekycHyConfig | Identity Verification本次流程启动的配置信息 |
EkycHyCallBack | ekycHyCallBack | 用来接收认证结果回调的接口 |
EkycHyConfig
EkycHyConfig是在启动Identity Verification(App SDK)时的配置实体类，主要包含了以下属性。
类型 | 名称 | 含义 | 默认值 |
OcrUiConfig | ocrUiConfig | ocr界面的一些自定义配置 | null |
String | licenseName | 客户申请的用户授权Licens文件名 | 空 |
int | ocrAutoTimeout | OCR_DETECT_AUTO_MANUAL模式下，自动捕获的超时时间（毫秒单位，最少设置5秒，内部上限30秒） | 20000毫秒（20秒） |
LanguageStyle | languageStyle | 本次流程的语言风格 | LanguageStyle.AUTO |
OcrModeType | ocrModeType | Ocr识别模式, 手动拍摄模式、自动识别模式、自动+手动识别模式 | OcrModeType.OCR_DETECT_MANUAL |
OcrRegionType | ocrType | 卡片类型 | null |
OcrRegionType
检测证件类型
枚举名 | 说明 |
HK | 香港证件 |
ML | 马来西亚证件 |
PhilippinesDrivingLicense | 菲律宾-驾驶执照 |
PhilippinesVoteID | 菲律宾-VoteID |
PhilippinesTinID | 菲律宾-TinID |
PhilippinesSSSID | 菲律宾-SSSID |
PhilippinesUMID | 菲律宾-UMID |
IndonesiaIDCard | 印尼证件 |
MLIDPassport | 护照 |
LanguageStyle
Identity Verification默认界面的多语言配置信息。
LanguageStyle类型 | 含义 |
LanguageStyle.AUTO | 跟随系统语言版本 |
LanguageStyle.ENGLISH | 英语 |
LanguageStyle.SIMPLIFIED_CHINESE | 简体中文 |
LanguageStyle.TRADITIONAL_CHINESE | 繁体中文 |
OcrModeType
Ocr识别模式
OcrModeType类型 | 含义 |
OCR_DETECT_MANUAL | 纯手动拍摄模式 |
OCR_DETECT_AUTO | 纯自动拍摄模式 |
OCR_DETECT_AUTO_MANUAL | 自动+手动识别模式 |
EkycHyCallBack
用于接收Identity Verification流程结果的监听类。
/*** Identity verification的结果回调类*/public interface EkycHyCallBack {/*** 识别成功的结果信息** @param result 结果信息*/void onSuccess(EkycHyResult result);/*** Identity verification流程失败的内容** @param errorCode 错误码* @param errorMsg 错误信息* @param ekycToken 当次流程的token*/void onFail(int errorCode, String errorMsg, String ekycToken);}
其中 EkycHyResult 是成功返回的结果对象。
EkycHyResult
EkycHyResult是Identity Verification(App SDK)流程成功后的结果对象。
类型 | 名称 | 含义 | 默认值 |
String | ekycToken | 当次Identity Verification流程的token，此token可以在服务器拉取身份认证过程关键数据 | 空 |
错误码与含义
错误码 | 对应含义 |
12000 | 用户主动取消 |
12001 | 网络请求失败 |
12002 | OCR识别异常导致的错误 |
12003 | 本地人脸检测失败引起的异常 |
12004 | 失效的token |
12005 | 本地卡证识别失败 |
12006 | Identity Verification(App SDK)初始化流程失败 |
12007 | 启动参数校验失败 |
12008 | 人脸核身结果返回失败 |
12009 | 人脸核身过程本地失败 |
是
否
本页内容是否解决了您的问题？