Identity Verification iOS 接口概述文档

Recent Pages

Identity Verification iOS 接口概述文档

最后更新时间：2023-08-10 15:03:03

API 概述
iOS端Identity Verification(App SDK)主要涉及的类主要包含VerificationKit、VerificationConfig、VerifiCommDef这几个主要类型下面对其支持的API做出详细说明。
 1.VerificationKit
VerificationKit为Identity Verification(App SDK)的对外接口类，主要逻辑也都是调用此类完成。
API
功能描述
initWithViewController
初始化接口
clearInstance
资源释放接口
startVerifiWithConfig
启动Identity Verification身份证核验的流程
1.1. initWithViewController
// 初始化方法- 
- (void)initWithViewController:(UIViewController *)viewController;
功能介绍：
​ IIdentity Verification(App SDK)的初始化接口。
传入参数:
参数类型
参数名称
参数含义
UIViewController
viewController
当前调用SDK页面VC对象
1.2 clearInstance
/// 清理SDK资源
+ (void)clearInstance;
功能介绍：
​SDK资源释放的接口。
1.3 startVerifiWithConfig:
/// 开启验证
- (void)startVerifiWithConfig:(VerificationConfig *)verifiConfig
            withSuccCallback:(TXYVerifiKitProcessSucceedBlock)succCallback
             withFialCallback:(TXYVerifiKitProcessFailedBlock)failCallback;
功能介绍：
​启动身份证核验的流程方法。
传入参数：
参数类型
参数名称
参数含义
VerificationConfig
verifiConfig
本次流程启动的配置信息
TXYVerifiKitProcessSucceedBlock
succCallback
SDK检测成功回调
TXYVerifiKitProcessFailedBlock
failCallback
SDK检测失败回调
1.4 TXYVerifiKitProcessSucceedBlock
SDK检测成功回调。
/// SDKKIt处理成功回调接口
/// @param errorCode 错误码
/// @param resultInfo 回调返回的信息
/// @param reserved 预留位
typedef void (^TXYVerifiKitProcessSucceedBlock)(int errorCode,id _Nonnull resultInfo, id _Nullable reserved);
1.5 TXYVerifiKitProcessFailedBlock
SDK检测失败回调。
/// SDKKIt处理失败回调接口
/// @param errorCode 错误码
/// @param errorMsg 错误信息
/// @param reserved 预留位
typedef void (^TXYVerifiKitProcessFailedBlock)(int errorCode, NSString *_Nonnull errorMsg, id _Nullable reserved);
2.VerificationConfig
VerificationConfig是在启动SDK时的配置实体类，主要包含了以下属性。
类型
名称
含义
默认值
NSString
ekycToken
从服务器端获取的Token值，作为此次核身唯一业务凭证
空
NSString
licPath
客户申请的用户授权Licens文件路径
空
long
hyFaceTimeOut
人脸核身单一动作的超时时间
10000毫秒（10秒）
BOOL
isHiddenAlbum
是否隐藏OCR相册按钮
NO
BOOL
isHiddenFlash
是否隐藏OCR手电筒按钮
NO
HYEkycLanguageType
languageType
本次流程的语言风格
DEFAULT (0)
OCRRegionType
ocrRegionType
卡证检测类型
0
NSString
userUIBundleName
用户自定义UI资源包名
Nil
NSString
userLanguageBundleName
用户自定义多语言资源包名
nil
NSString
userLanguageFileName
指定自定义多语言使用文件名
nil
3.VerifiCommDef
3.1 HYEkycLanguageType
SDK默认界面的多语言配置信息。
类型
含义
HY_EKYC_DEFAULT = 0
跟随系统语言版本
HY_EKYC_ZH_HANS
简体中文
HY_EKYC_ZH_HANT
繁体中文
HY_EKYC_EN
英语
HY_EKYC_CUSTOMIZE_LANGUAGE
自定义语言，使用设置的自定义语言bundle（userLanguageBundleName）
3.2 OCRRegionType
卡证检测类型。
枚举名
说明
OCR_TYPE_DEFULT = 0
默认空
OCR_TYPE_HK
香港证件
OCR_TYPE_ML
马来西亚证件
OCR_TYPE_PV_ID
菲律宾-驾驶执照证件
OCR_TYPE_PDL
菲律宾-VoteID证件
OCR_TYPE_INDONESIA
印尼证件
OCR_TYPE_SINGAPORE
新加坡证件
OCR_TYPE_PH_TINID
菲律宾-TINID
OCR_TYPE_PH_SSSID
菲律宾-SSSID
OCR_TYPE_PH_UMID
菲律宾-UMID
OCR_TYPE_MLID_PASSPORT
护照证件
4.错误码与含义
错误码
错误码值
错误码含义
HY_SUCCESS
0
成功
HY_VERIFI_FAIL
-1
检测失败
HY_VERIFI_OCR_FAIL
-2
卡证识别失败
HY_SDK_INNER_ERR
-4
慧眼内部错误
HY_INITIALIZATION_PARAMETER_EXCEPTION
310
初始化参数异常
HY_BUNDLE_CONFIGURATION_EXCEPTION
311
bundle配置异常
HY_YTSDK_CONFIGURATION_EXCEPTION
312
优图配置异常
HY_PLEASE_CALL_FIRST_INIT_API
313
先调用初始化接口
HY_SDK_AUTH_FAILED
314
SDK 授权失败
HY_USER_VOLUNTARILY_CANCELED
315
用户手动取消
HY_YTSDK_LOCAL_AUTH_FAILED
316
SDK 人脸本地检测失败
HY_CAMERA_OPEN_FAIL
317
相机开启失败
HY_DONOT_SWITCH_APPS
318
请勿在核身过程中切换应用
HY_CAMEREA_PERMISSION_EXCEPTION
319
摄像头权限异常
HY_SDK_VEDIO_CUT_EXCEPTION
320
视频裁剪失败
HY_LIGHT_DATA_FORMAT_EXCEPTION
321
光线数据格式错误
HY_GET_REMOTE_DATA_EXCEPTION
322
获取远程数据错误
﻿

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

Identity Verification iOS 接口概述文档

API 概述

1.VerificationKit

1.1. initWithViewController

1.2 clearInstance

1.3 startVerifiWithConfig:

1.4 TXYVerifiKitProcessSucceedBlock

1.5 TXYVerifiKitProcessFailedBlock

2.VerificationConfig

3.VerifiCommDef

3.1 HYEkycLanguageType

3.2 OCRRegionType

4.错误码与含义

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

API	功能描述
initWithViewController	初始化接口
clearInstance	资源释放接口
startVerifiWithConfig	启动Identity Verification身份证核验的流程

参数类型	参数名称	参数含义
UIViewController	viewController	当前调用SDK页面VC对象

类型	名称	含义	默认值
NSString	ekycToken	从服务器端获取的Token值，作为此次核身唯一业务凭证	空
NSString	licPath	客户申请的用户授权Licens文件路径	空
long	hyFaceTimeOut	人脸核身单一动作的超时时间	10000毫秒（10秒）
BOOL	isHiddenAlbum	是否隐藏OCR相册按钮	NO
BOOL	isHiddenFlash	是否隐藏OCR手电筒按钮	NO
HYEkycLanguageType	languageType	本次流程的语言风格	DEFAULT (0)
OCRRegionType	ocrRegionType	卡证检测类型	0
NSString	userUIBundleName	用户自定义UI资源包名	Nil
NSString	userLanguageBundleName	用户自定义多语言资源包名	nil
NSString	userLanguageFileName	指定自定义多语言使用文件名	nil

类型	含义
HY_EKYC_DEFAULT = 0	跟随系统语言版本
HY_EKYC_ZH_HANS	简体中文
HY_EKYC_ZH_HANT	繁体中文
HY_EKYC_EN	英语
HY_EKYC_CUSTOMIZE_LANGUAGE	自定义语言，使用设置的自定义语言bundle（userLanguageBundleName）

枚举名	说明
OCR_TYPE_DEFULT = 0	默认空
OCR_TYPE_HK	香港证件
OCR_TYPE_ML	马来西亚证件
OCR_TYPE_PV_ID	菲律宾-驾驶执照证件
OCR_TYPE_PDL	菲律宾-VoteID证件
OCR_TYPE_INDONESIA	印尼证件
OCR_TYPE_SINGAPORE	新加坡证件
OCR_TYPE_PH_TINID	菲律宾-TINID
OCR_TYPE_PH_SSSID	菲律宾-SSSID
OCR_TYPE_PH_UMID	菲律宾-UMID
OCR_TYPE_MLID_PASSPORT	护照证件

错误码	错误码值	错误码含义
HY_SUCCESS	0	成功
HY_VERIFI_FAIL	-1	检测失败
HY_VERIFI_OCR_FAIL	-2	卡证识别失败
HY_SDK_INNER_ERR	-4	慧眼内部错误
HY_INITIALIZATION_PARAMETER_EXCEPTION	310	初始化参数异常
HY_BUNDLE_CONFIGURATION_EXCEPTION	311	bundle配置异常
HY_YTSDK_CONFIGURATION_EXCEPTION	312	优图配置异常
HY_PLEASE_CALL_FIRST_INIT_API	313	先调用初始化接口
HY_SDK_AUTH_FAILED	314	SDK 授权失败
HY_USER_VOLUNTARILY_CANCELED	315	用户手动取消
HY_YTSDK_LOCAL_AUTH_FAILED	316	SDK 人脸本地检测失败
HY_CAMERA_OPEN_FAIL	317	相机开启失败
HY_DONOT_SWITCH_APPS	318	请勿在核身过程中切换应用
HY_CAMEREA_PERMISSION_EXCEPTION	319	摄像头权限异常
HY_SDK_VEDIO_CUT_EXCEPTION	320	视频裁剪失败
HY_LIGHT_DATA_FORMAT_EXCEPTION	321	光线数据格式错误
HY_GET_REMOTE_DATA_EXCEPTION	322	获取远程数据错误

tencent cloud

注册

登录

Recent Pages

Identity Verification iOS 接口概述文档

API 概述

1.VerificationKit

1.1. initWithViewController

1.2 clearInstance

1.3 startVerifiWithConfig:

1.4 TXYVerifiKitProcessSucceedBlock

1.5 TXYVerifiKitProcessFailedBlock

2.VerificationConfig

3.VerifiCommDef

3.1 HYEkycLanguageType

3.2 OCRRegionType

4.错误码与含义

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？