产品动态
产品公告
API | 功能描述 |
initWithViewController | 初始化接口 |
clearInstance | 资源释放接口 |
startVerifiWithConfig | 启动卡证活体人脸比对的流程 |
// 初始化方法- (void)initWithViewController:(UIViewController *)viewController;
参数类型 | 参数名称 | 参数含义 |
UIViewController | viewController | 当前调用 SDK 页面 VC 对象 |
/// 清理SDK资源+ (void)clearInstance;
/// 开启验证- (void)startVerifiWithConfig:(VerificationConfig *)verifiConfigwithSuccCallback:(TXYVerifiKitProcessSucceedBlock)succCallbackwithFialCallback:(TXYVerifiKitProcessFailedBlock)failCallback;
参数类型 | 参数名称 | 参数含义 |
VerificationConfig | verifiConfig | 本次流程启动的配置信息 |
TXYVerifiKitProcessSucceedBlock | succCallback | SDK 检测成功回调 |
TXYVerifiKitProcessFailedBlock | failCallback | SDK 检测失败回调 |
/// SDKKIt处理成功回调接口/// @param errorCode 错误码/// @param resultInfo 回调返回的信息/// @param reserved 预留位typedef void (^TXYVerifiKitProcessSucceedBlock)(int errorCode,id _Nonnull resultInfo, id _Nullable reserved);
/// SDKKIt处理失败回调接口/// @param errorCode 错误码/// @param errorMsg 错误信息/// @param reserved 预留位typedef void (^TXYVerifiKitProcessFailedBlock)(int errorCode, NSString *_Nonnull errorMsg, id _Nullable reserved);
类型 | 名称 | 含义 | 默认值 |
NSString | licPath | 客户申请的用户授权License文件路径 | 空 |
BOOL | openCheckRiskMode | NO | |
NSString | riskLicense | 风控授权文件路径，openCheckRiskMode 为 YES 时必填 | 空 |
NSString | ekycToken | 从服务器端获取的 Token 值，作为此次核身唯一业务凭证 | 空 |
HYEkycLanguageType | languageType | 设置 SDK 语言类型 | HY_EKYC_EN |
BOOL | isHiddenAlbum | 是否隐藏 OCR 环节中从相册获取本地图片的按钮 | NO |
BOOL | isHiddenFlash | 是否隐藏 OCR 环节中打开手电筒的按钮 | NO |
NSString | userLanguageFileName | 自定义语言 Bundle 中目标 .lproj 文件夹名称，如 ja.lproj。仅 languageType 为 HY_EKYC_CUSTOMIZE_LANGUAGE 时生效 | 空 |
BOOL | isShowPrivacyAgreementDialog | 是否在验证流程开始前显示隐私协议弹窗 | YES |
CGFloat | ocrAutoTimeout | 用户自定义 UI 资源包名 | 空 |
CGFloat | livenessAutoTimeout | 用户自定义多语言资源包名 | 空 |
BOOL | isOpenClipImage | 指定自定义多语言使用文件名 | NO |
BOOL | isUseBackCameraOnFaceAuth | 是否在人脸检测阶段使用后置摄像头 | NO |
BOOL | supportSystemAdjustsFont | 是否响应系统无障碍设置中的字体大小调整 | NO |
OcrCustomConfig | ocrCustomConfig | OCR 阶段自定义 UI 配置，控制识别框颜色、提示文本样式等 | 空 |
FaceCustomConfig | faceCustomConfig | 人脸阶段自定义 UI 配置，控制背景色、提示文本样式、圆框颜色等 | 空 |
VerificationDelegate | delegate | SDK 界面生命周期事件代理，可监听 OCR/人脸界面的创建与销毁 | 空 |
NSString | userUIBundlePath | 用户自定义 UI 资源包绝对路径；未使用自定义 UI 默认为空 | 空 |
NSString | userLanguageBundlePath | 用户自定义多语言资源包绝对路径；为 nil 时使用 mainBundle 中的 huiyan_verification.bundle | 空 |
NSString | huiyanSDKBundlePath | 活体人脸比对环节的 UI 资源包绝对路径（HuiYanSDKUI.bundle）；为 nil 时使用 mainBundle 中的 HuiYanSDKUI.bundle | 空 |
NSString | verificationBundlePath | 卡证活体人脸比对环节核心验证资源包绝对路径（huiyan_verification.bundle）；为 nil 时使用 mainBundle 中的 huiyan_verification.bundle | 空 |
NSString | ocrSDKBundlePath | OCR（证件识别和鉴伪）环节资源包绝对路径（OcrSDK.bundle），用于动态下载场景；为 nil 时使用 mainBundle 中的 OcrSDK.bundle。 | 空 |
NSString | faceTrackerBundlePath | 本地人脸检测环节资源包绝对路径（face-tracker-v003.bundle），用于动态下载场景；为 nil 时使用 mainBundle 中的 face-tracker-v003.bundle | 空 |
类型 | 名称 | 含义 | 默认值 |
UIColor | rectNormalColor | 识别框正常状态颜色 | 空 |
UIColor | rectErrorColor | 识别框错误状态颜色 | 空 |
UIColor | rectPassColor | 识别框通过状态颜色 | 空 |
UIColor | tipsNormalColor | 提示文字正常状态颜色 | 空 |
UIColor | tipsErrorColor | 提示文字错误状态颜色 | 空 |
UIColor | tipsPassColor | 提示文字通过状态颜色 | 空 |
UIFont | tipsFont | 提示文字字体（设置后优先于 tipsFontSize） | 空 |
CGFloat | rectScaleX | 识别框横向边距占屏幕宽度的比例，取值范围 0.0~0.15 | 0.03 |
CGFloat | rectTopMarginScale | 识别框顶部边距占屏幕高度的比例（仅竖屏有效，横屏时居中显示） | 0.28 |
BOOL | isShowTips | 是否显示提示文字 | YES |
NSString | tipsShowText | 自定义提示文字内容，为 nil 时显示 SDK 默认文案 | 空 |
类型 | 名称 | 含义 | 默认值 |
UIColor | backgroundColor | 人脸验证页面背景颜色 | 空 |
UIColor | tipsTextColor | 提示文字颜色（正常状态） | 空 |
UIColor | tipsTextErrorColor | 提示文字颜色（错误状态） | 空 |
UIFont | tipsTextFont | 提示文字字体（含大小） | 空 |
UIColor | faceCircleErrorColor | 人脸圆框颜色（错误状态） | 空 |
UIColor | faceCircleCorrectColor | 人脸圆框颜色（正确状态） | 空 |
UIColor | countDownTextColor | 倒计时文字颜色 | 空 |
UIColor | cancelButtonTextColor | 取消按钮文字颜色 | 空 |
类型 | 含义 |
HY_EKYC_DEFAULT = 0 | 跟随系统语言版本 |
HY_EKYC_ZH_HANS | 简体中文 |
HY_EKYC_ZH_HANT | 繁体中文 |
HY_EKYC_EN | 英语 |
HY_EKYC_CUSTOMIZE_LANGUAGE | 自定义语言，使用设置的自定义语言bundle（userLanguageBundleName） |
@protocol VerificationDelegate <NSObject>@optional/// OCR界面创建回调，authView 为 SDK 展示的根视图- (void)ocrMainViewCreate:(UIView *)authView;/// OCR界面被移除时回调- (void)ocrMainViewDestroy;/// 人脸界面创建回调，authView 为 SDK 展示的根视图- (void)faceMainViewCreate:(UIView *)authView;/// 人脸界面被移除时回调- (void)faceMainViewDestroy;@end
错误码 | 错误码值 | 错误码含义 |
HY_EKYC_SUCCESS | 0 | 成功 |
HY_EKYC_VERIFI_FAIL | -1 | 检测失败 |
HY_EKYC_VERIFI_OCR_FAIL | -2 | 证件识别失败 |
HY_EKYC_SDK_INNER_ERR | -4 | SDK 内部错误 |
HY_EKYC_NETWORK_ERROR | 272 | 网络异常 |
HY_EKYC_INITIALIZATION_PARAMETER_EXCEPTION | 310 | 初始化参数异常 |
HY_EKYC_BUNDLE_CONFIGURATION_EXCEPTION | 311 | bundle 配置异常 |
HY_EKYC_PLEASE_CALL_FIRST_INIT_API | 313 | 先调用初始化接口 |
HY_EKYC_SDK_AUTH_FAILED | 314 | SDK 授权失败 |
HY_EKYC_USER_VOLUNTARILY_CANCELED | 315 | 用户手动取消 |
HY_EKYC_GET_REMOTE_DATA_EXCEPTION | 322 | 获取远程数据错误 |
文档反馈