开发者中心

上海璟梦信息科技有限公司实人认证&活体检测 SDK 集成文档 V1.0.0.2

名称: 上海璟梦信息科技有限公司实人认证&活体检测 iOS SDK 集成文档
版本: V1.0.0.2
作者: Guevara·NS
更新日期: 2021-07-29
邮箱: wangyd@253.com

合规性说明

SDK名称 场景描述 收集个人信息的类型 第三方机构名称 数据是否加密传输 第三方隐私政策链接
上海璟梦信息科技有限公司实名认证SDK 活体检测 上海璟梦信息科技有限公司实人认证&活体检测SDK提供活体检测服务过程中收集和使用的信息包括:
用户的面部识别信息、用户的设备摄像头权限:用于活体检测服务中人脸检测、人脸检索、人脸比对;
上海璟梦信息科技有限公司 http://git.253.com/wanggang/sdk-release-package

一、SDK集成

1、获取SDK

从官网下载活体检测 sdk 包。

2、开发环境搭建

  1. 导入FrameWork :将实人认证SDK压缩包中framework中的所有资源添加到工程中,并选择 Copy Items if need  选项

image.png

  1. 配置Xcode
  • 关闭Bitcode 。设置Xcode->TARGETS->Build Setitngs->EnableBitcode  为NO

image.png

  • Xcode->TARGETS->Build Settings->Linking->Other Linker Flags 添加–ObjC

image.png

  • 添加系统依赖库

CoreData.framework
AssetsLibrary.framework
CoreMedia.framework
AVFoundation.framework
libc++.tbd

  • Xcode->TARGETS->Info添加相机权限访问描述

image.png

3、 SDK 初始化

3.1、建议在 Application 的 didFinishLaunchingWithOptions 方法中进行初始化:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    ...
    
    [CLCoreManager printConsoleEnable:YES];
    [CLCoreManager initWithAppid:@" appid "];
    
    ...
    return YES;
}

注意:在 initWithAppid: 中设置 appId

温馨提示:
**appId **查看路径,登录开发者平台,右上角点击「应用管理」找到自己的应用,点击后面的「配置」按钮,然后可以看到 appId 了,点击复制按钮即可。

4、调用活体检测功能

4.1 回调数据说明

① 当活体检测完成时,会在 completionHandler 回调方法中回调如下数据:

{
    "uuid": "590B6E4484C7CEEB951F7E840466C695447127B50C72931F1512E7EA6EB68282C2A931BDF73FDECFAB712E5AABD4297A",
    "token": "gPXZtMJN1pGPOgDAjJsfSrkmlslaz7iY715IOt/VWsn+kEMPa6/uwK9FB3Cuujrl/VQ84iFqhOB00HFG4Ai+k7q1P447N7AitTslKOUJyDSV0eo03IuPCEN/T351DvcfjbWLs/tMDTreutu7jkA3vwwP1VUl77RcyfdwMixnM5U="
}

② 会在 completionHandler中回调 CLStatus 信息,具体的错误信息如下表所示:

CLStatus 错误信息 备注说明
CLCheckPass 活体检测通过 /
CLCheckNotPass 活体检测不通过 /
CLOperationTimeout 操作超时,用户未在规定时间内完成动作 /
CLGetConfTimeout 活体检测获取配置信息超时 /
CLOnlineCheckTimeout 云端检测结果请求超时 /
CLOnlineUploadFailure 云端检测上传图片失败 /
CLNonGateway 网络未连接 /
CLSDKError SDK内部发生错误 /
CLCameraNotAvailable App未获取相机权限 /

温馨提示:
① 调用活体检测方法之前,请确保已经获取到相机、!!!
② 我们提供了默认的声音文件和 GIF 图片文件,如不满意可以替换,声音文件支持 mp3、wav 等常见格式**;**
③ 声音和动作提示的 GIF 图片必须设置,否则会没有提示音和动作动画显示;

5、调用身份证 OCR 功能

身份证 OCR 接口封装了常用 OCR 的使用场景,例如,身份证单面 OCR,身份证双面 OCR,身份证二要素认证等类型,可根据自己的实际需求,选择合适的调用类型。

5.1 默认调用方式

示例代码如下:


/// 身份证OCR接口    ⚠️ 先调用人像面
/// @param image                    身份证图片
/// @param isFront                  YES:为人像面 NO:为国徽面
/// @param complecte 结果回调
+ (void)realPersonOCR:(UIImage *)image isFront:(BOOL)isFront complect:(CLCoreNetComplete)complecte;

/// 身份证OCR接口    识别人像面和国徽面(单图片大小建议压缩为1M以内,超过会被SDK压缩)
/// @param frontImage               人像面照片
/// @param backImage                国徽面照片
/// @param complecte                结果回调 
+ (void)realPersonOCR:(UIImage *)frontImage backImage:(UIImage *)backImage complect:(CLCoreNetComplete)complecte;

/// 身份证认证
/// @param name                     姓名
/// @param idNumber                 身份证号码
/// @param complecte                结果回调
+ (void)realPersonDectect:(NSString *)name idNumber:(NSString *)idNumber complect:(CLCoreNetComplete)complecte;

5.2 调用方式

具体逻辑参考demo,demo提供了具体的UI和逻辑实现。

二、、历史版本

发布日期 发布版本 更新说明
2021-07-05 V1.0.0.0 初版发布
2021-07-12 V1.0.0.1 优化SDK包体积
2021-07-29 V1.0.0.2 新增身份证双面OCR接口,优化OCR接口安全性