安全模式 | 安全级别 | 功能描述 | 适用场景 | 所需 License |
基础版 | 标准 | 提供基础的活体检测和人脸比对能力 | 一般业务场景,对安全要求标准的场景 | YTFaceSDK.license (基础授权) |
增强版 (Enhance Mode) | 高 | 在基础版基础上增加设备风控能力,提升设备安全性和活体检测准确度 | 对安全要求较高的场景,如金融开户、重要账户验证等 | YTFaceSDK.license(基础授权) |
Plus 版 (Plus Mode) | 极高 | 活体检测+人脸1:1识别+设备风控+AI 防护盾 | 对安全要求极高的场景,如大额交易、敏感信息变更等 | YTFaceSDK.license(基础授权) |

Token 以及通过 Token 获取最终的核身结果。
package mainimport ("encoding/json""log""net/http""os""github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common""github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"faceid "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/faceid/v20180301")var FaceIdClient *faceid.Clientfunc init() {// 初始化客户端配置对象,您可以指定超时时间和其他配置项prof := profile.NewClientProfile()prof.HttpProfile.ReqTimeout = 60// TODO 需要替换成您调用账号的 SecretId 和 SecretKeycredential := cloud.NewCredential("SecretId", "SecretKey")var err error// 初始化调用 eKYC 人脸核身服务的客户端FaceIdClient, err = faceid.NewClient(credential, "ap-singapore", prof)if nil != err {log.Fatal("FaceIdClient init error: ", err)}}// writeJSON 统一输出 JSON 响应:设置 Content-Type、状态码并编码写入。func writeJSON(w http.ResponseWriter, status int, v interface{}) {w.Header().Set("Content-Type", "application/json; charset=utf-8")w.WriteHeader(status)_ = json.NewEncoder(w).Encode(v)}// GetFaceIdToken 获取人脸核身Tokenfunc GetFaceIdToken(w http.ResponseWriter, r *http.Request) {log.Println("get face id token")// 步骤1: 解析请求参数if err := r.ParseForm(); err != nil {http.Error(w, "bad request", http.StatusBadRequest)return}var CheckMode = r.FormValue("CheckMode")var SecureLevel = r.FormValue("SecureLevel")var MetaData = r.FormValue("MetaData")var Image = r.FormValue("Image")// 步骤2: 初始化请求对象,并给必要的参数赋值request := faceid.NewGetFaceIdTokenIntlRequest()request.CheckMode = &CheckModerequest.SecureLevel = &SecureLevelrequest.MetaData = &MetaDataif CheckMode == "compare" {request.Image = &Image}// 步骤3: 通过FaceIdClient调用人脸核身服务response, err := FaceIdClient.GetFaceIdTokenIntl(request)// 步骤4: 处理腾讯云API的响应,并构造返回对象if nil != err {writeJSON(w, http.StatusInternalServerError, map[string]string{"code": "Error","message": err.Error(),})return}SdkToken := response.Response.SdkTokenServerParamInfo := response.Response.ServerParamInfoapiResp := struct {SdkToken *string `json:"SdkToken"`ServerParamInfo *string `json:"ServerParamInfo"`}{SdkToken: SdkToken, ServerParamInfo: ServerParamInfo}// ... 其他业务处理代码//步骤5: 返回服务响应writeJSON(w, http.StatusOK, apiResp)}// GetFaceIdResult 获取人脸核身核验结果func GetFaceIdResult(w http.ResponseWriter, r *http.Request) {// 步骤1: ... 解析请求参数if err := r.ParseForm(); err != nil {http.Error(w, "bad request", http.StatusBadRequest)return}SdkToken := r.FormValue("SdkToken")// 步骤2: 初始化请求对象,并给必要的参数赋值request := faceid.NewGetFaceIdResultIntlRequest()request.SdkToken = &SdkToken// 步骤3: 通过FaceIdClient调用人脸核身服务response, err := FaceIdClient.GetFaceIdResultIntl(request)// Step 4: 处理腾讯云API的响应,并构造返回对象if nil != err {writeJSON(w, http.StatusInternalServerError, map[string]string{"code": "Error","message": err.Error(),})return}result := response.Response.ResultapiResp := struct {Result *string}{Result: result}b, _ := json.Marshal(apiResp)// ... 其他业务处理代码//步骤5: 返回服务响应writeJSON(w, http.StatusOK, apiResp)}func main() {// 注册http接口路径http.HandleFunc("/api/v1/get-token", GetFaceIdToken)http.HandleFunc("/api/v1/get-result", GetFaceIdResult)// 监听端口err := http.ListenAndServe(":8080", nil)if nil != err {log.Fatal("ListenAndServe error: ", err)}}
SdkToken , 访问 http://ip:port/api/v1/get-result 接口查看 Result 字段的响应是否为 0 以判断服务端集成是否成功,具体的响应结果详见 API 接口部分的介绍。├── codedemo│ ├── build.gradle│ ├── libs│ │ ├── huiyansdk_android_overseas_1.x.x.x_release.aar│ │ ├── huiyanaudio-oversea_1.x.x_release.aar (可选,开启语音播报时需要)│ │ ├── tencent-ai-sdk-aicamera-1.x.x.x-release.aar│ │ ├── tencent-ai-sdk-common-1.x.x.x-release.aar│ │ ├── tencent-ai-sdk-network-1.x.x.x-release.aar│ │ ├── tencent-ai-sdk-risk-oversea-1.x.x.x-release.aar│ │ └── tencent-ai-sdk-youtu-base-1.x.x.x-release.aar│ ├── proguard-rules.pro│ └── src│ └── main
// 设置ndk so架构过滤(以arm64-v8a为例,如果设备支持armeabi-v7a也可以加)defaultConfig {ndk {abiFilters 'arm64-v8a'}}dependencies {// 引入eKYC SDKimplementation files("libs/huiyansdk_android_overseas_1.x.x.x_release.aar")// eKYC 通用算法SDKimplementation files("libs/tencent-ai-sdk-youtu-base-1.x.x.x-release.aar")// 通用能力组件库implementation files("libs/tencent-ai-sdk-common-1.x.x.x-release.aar")implementation files("libs/tencent-ai-sdk-aicamera-1.x.x.x-release.aar")implementation files("libs/tencent-ai-sdk-network-1.x.x.x-release.aar")implementation files("libs/tencent-ai-sdk-risk-oversea-1.x.x.x-release.aar")// 可选:语音播报资源包(仅当需要开启语音播报,即 HuiYanOsConfig.setOpenAudio(true) 时才需要引入)implementation files("libs/huiyanaudio-oversea_1.x.x_release.aar")// SDK需要依赖的第三方库// gsonimplementation 'com.google.code.gson:gson:2.8.9'}
<!-- 摄像头权限 --><uses-permission android:name="android.permission.CAMERA" /><uses-featureandroid:name="android.hardware.camera"android:required="true" /><!-- SDK需要的网络权限 --><uses-permission android:name="android.permission.INTERNET" /><!-- 设备风控需要依赖 --><uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /><!-- SDK可选需要的权限 --><uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
@Overridepublic void onCreate() {super.onCreate();instance = this;// SDK需要在Application初始化时进行初始化HuiYanOsApi.init(getApp());}

// HuiYanOs的相关参数HuiYanOsConfig huiYanOsConfig = new HuiYanOsConfig();// 此license文件存放在assets下huiYanOsConfig.setAuthLicense("YTFaceSDK.license");// 透传云 API 下发的 ServerParamInfo(申请 SdkToken 时一并返回,必传)huiYanOsConfig.setServerParamInfo(serverParamInfo);if (compatCheckBox.isChecked()) {huiYanOsConfig.setPageColorStyle(PageColorStyle.Dark);}// 启动核身方法,开始的活体,currentToken为后台下发数据HuiYanOsApi.startHuiYanAuth(currentToken, huiYanOsConfig, new HuiYanOsAuthCallBack() {@Overridepublic void onSuccess(HuiYanOsAuthResult authResult) {//显示结果runOnUiThread(new Runnable() {@Overridepublic void run() {Toast.makeText(SimplifyActivity.this, "活体通过!", Toast.LENGTH_SHORT).show();}});}@Overridepublic void onFail(int errorCode, String errorMsg, String token) {String msg = "活体失败 " + "code: " + errorCode + " msg: " + errorMsg + " token: " + token;Log.e(TAG, "onFail" + msg);//显示结果runOnUiThread(new Runnable() {@Overridepublic void run() {Toast.makeText(SimplifyActivity.this, msg, Toast.LENGTH_SHORT).show();}});}});
├── codedemo│ ├── build.gradle│ ├── libs│ ├── proguard-rules.pro│ └── src│ └── main│ └── assets│ └── YTFaceSDK.license
@Overrideprotected void onDestroy() {super.onDestroy();// 退出时做资源释放HuiYanOsApi.release();}
#SDK的混淆包含-keep class com.tencent.could.huiyansdk.** {*;}-keep class com.tencent.could.aicamera.** {*;}-keep class com.tencent.could.component.** {*;}-keep class com.tencent.youtu.** {*;}-keep class com.tenpay.utils.SMUtils {*;}-keep class com.tencent.turingface.** {*;}-keep class com.turingface.sdk.** {*;}-keep class com.tencent.cloud.ai.network.** {*;}
├──Accelerate.framework└──HuiYanOverseasSDK.xcframework

├──YTFaceSDK.license├──face-tracker-v003.bundle├──HuiYanSDKUI.bundle└──HuiYanAudioBundle.bundle(可选)

├──Your Project.xcodeproj├──Podfile├──CloudHuiYanSDK_FW├───────CloudHuiYanSDK_FW.podspec├───────Frameworks├────────────HuiYanOverseasSDK.xcframework├───────Resources├────────────HuiYanSDKUI.bundle├────────────HuiYanAudioBundle.bundle└────────────face-tracker-v003.bundle
Pod::Spec.new do |s|s.name = "CloudHuiYanSDK_FW"s.version = "1.0.0"s.platform = :ios, "15.0"s.summary = 'frameworks and bundle resources for youtu mobile hdr's.homepage = 'xx's.license = 'MIT's.source = {:git => 'xx' ,:tag => "#{s.version}"}s.static_framework = trues.compiler_flags = "-ObjC"s.author = {'xx' => 'xx'}s.pod_target_xcconfig = {'VALID_ARCHS' =>['arm64', 'x86_64']}s.subspec 'Resources' do |framework|framework.resource = 'Resources/*.bundle'ends.subspec 'Framework' do |framework|framework.frameworks = 'Accelerate'framework.vendored_frameworks = 'Frameworks/*.xcframework'endend
target 'HuiYanAuthDemo' douse_frameworks!pod 'CloudHuiYanSDK_FW', :path => './CloudHuiYanSDK_FW'end
Build Settings的Framework Search Paths中添加$(inherited)
Build Settings的Other Linker Flags中添加$(inherited)
key-value 值。<key>Privacy - Camera Usage Description</key><string>人脸核身需要开启您的摄像头权限,用于人脸识别</string>

#import <HuiYanOverseasSDK/HuiYanSDK.h>//获取tokenNSString *faceToken = self.tokenTextField.text;//配置SDKHuiYanOsConfig *config = [[HuiYanOsConfig alloc] init];//设置licconfig.authLicense = [[NSBundle mainBundle] pathForResource:@"YTFaceSDK" ofType:@"license"];//准备阶段超时配置config.prepareTimeoutMs = 20000;//动作阶段超时配置config.actionTimeoutMs = 20000;// 删除本地活体视频config.isDeleteVideoCache = YES;// 设置UI相关回调config.delegate = self;//自定义多语言配置config.languageType = EN;// config.userLanguageFileName = @"ko";// config.userLanguageBundleName = @"UseLanguageBundle";config.iShowTipsPage = YES;[[HuiYanOSKit sharedInstance] startHuiYaneKYC:faceToken withConfig:config withSuccCallback:^(HuiYanOsAuthResult * _Nonnull authResult, id _Nullable reserved) {NSString *token = authResult.faceToken;} withFailCallback:^(int errCode, NSString * _Nonnull errMsg, id _Nullable reserved) {NSString *showMsg = [NSString stringWithFormat:@"err:%d:%@",errCode,errMsg];NSLog(@"err:%@",showMsg);}];
HuiYanOsConfig *config = [[HuiYanOsConfig alloc] init];config.authLicense = [[NSBundle mainBundle] pathForResource:@"YTFaceSDK" ofType:@"license"];
GetFaceIdTokenIntl 或 ApplySdkVerificationToken 接口获取业务 Token 时,需要通过设置 SdkVersion 参数来指定启用增强模式或 Plus 模式:SdkVersion 值SdkVersion 值文档反馈