iOS集成文档
iOS集成文档
1、SDK下载
请联系技术支持 QQ：3007288470
2、获取个推应用参数
说明：进入个推开发者中心（dev.getui.com），在应用管理中添加”实名认证“服务，获取对应的APPID。
3、配置SDK
Xcode集成方式
我们提供的一个SDK开发工具包，包含了iOS SDK 的全部所需资源
解压后文件目录结构
CtidDemo：SDK演示Demo，更好的展示SDK的功能点
SdkLib：包含集成SDK所需头文件和.A库
4、SDK接口说明
4.1、初始化接口
接口说明
/**
* 启动SDK
* @param appId 您申请的appId
* @param completion 结果回调
*/
+ (void)startSDKWithAppId:(NSString *_Nonnull)appId completion:(CtidInitCallback _Nonnull)completion;
SDK初始化后回调completion，若isSuccess为真则初始化成功，否则根据error查看具体失败原因
使用示例
[CtidSdk startSDKWithAppId:@"a9PFarFczhA5SYqwgGAsd5" completion:^(BOOL isSuccess, NSString *gtCid, NSString *error) {
NSLog(@"isSuccess :%d, gtCid:%@, error:%@", isSuccess, gtCid, error);
}];
4.2、验证接口
接口说明
/**
* 验证身份信息
* @param idNum 身份照吗
* @param name 姓名
* @param photoData 画像数据-可选
* @param completion 结果回调
*/
+ (void)verifyWithIdNum:(NSString *_Nonnull)idNum name:(NSString *_Nonnull)name photoData:(NSString *_Nullable)photoData completion:(CtidDicCallback __nonnull)completion;
| 参数 | 必填 | 类型 | 描述 |
|---|---|---|---|
| name | 是 | string | 用户身份证姓名 |
| idNum | 是 | string | 用户身份证号码 |
| photoData | 否 | string | 用户的头像图片所对应字节数组的Base64编码(图片数据base64，建议使用jpg格式，大小5K-50K) |
| completion | 是 | block | 用于受验证的结果回调 |
使用示例
NSString *name = self.nameInput.text;
NSString *number = self.numberInput.text;
[CtidSdk verifyWithIdNum:number name:name photoData:nil completion:^(NSDictionary *dic) {
NSLog(@"startVerify callback: %@", dic);
}];
返回示例
说明：pid为互联网身份标识
{
"code" : 200,
"errorCode" : "0XXX",
"msg" : "success",
"pid" : "CSCuqj2s1v\/HZTsSbhhpE4Wv3t6XVI8fu9onJR7YFpt0MjAyMDA0MjYxNTAzNTgwRQIgRYcJXj3xHJ0+sGt4w7gG56NtJAFxIshivJlrrfbEzlICIQCNmArFH5Imwru7EeEHxBL7IQ81lXRd3UeH6gLazb1zcwA="
}
4.3、获取版本号
接口说明
/**
* 获取SDK版本信息
*/
+ (NSString *__nonnull) getVersion;
5、状态码
code
| 状态码 | 含义 |
|---|---|
| 200 | 成功 |
| 500 | 失败 |
errorCode
| 错误码 | 含义 |
|---|---|
| 1001 | 未初始化 |
| 1002 | 接口参数错误 |
| 1003 | appId为空 |
| 1004 | 网络请求异常 |
| 1005 | 接口调用频率过高 |
| 1006 | 服务器数据返回异常 |
详细说明：若errorCode不为1开头，则为中盾业务标识，一般为4位数字
第一位数字为姓名身份证匹配结果，第二位数字为人像匹配结果，第三位与第四位暂时不用关注。
例如51XX，第一位字符为5，代表身份信息无效；第二位字符为1，代表人像不匹配，非同一人。
具体规则如下：
| 第一位字符：身份信息匹配比对 | 含义 |
|---|---|
| 0 | 身份信息有效 |
| 5 | 身份信息无效 |
| 6 | 参数错误 |
| 7 | 系统错误 |
| 9 | 公安接口访问次数用尽 |
| A | 穿网调用超时 |
| E | 公安接口调用异常 |
| T | 公安接口调用超时 |
| X | 未执行 |
| Z | 该业务站点配置的公安网访问次数耗尽 |
| 第二字符:人像比对 | 含义 |
|---|---|
| 0 | 同一人(人像加密) |
| 1 | 非同一人(人像加密) |
| 2 | 疑似(人像加密) |
| A | 人像比对数据库操作异常 |
| B | 人像比对异常 |
| C | 输入参数错误 |
| D | 无人像信息 |
| E | 非 JPEG 格式的图像 |
| F | 待比对图像建模失败 1. 照片可能有角度、光线过暗、脸部 区域有亮斑、模糊 2. 照片尺寸太小 |
| G | 客户方上传照片质量不合格 |
| H | 活体检测控件版本过期 |
| I | 加密的人像图像数据校验失败 |
| J | 现场照片小于 5K 字 节 |
| K | 公安制证照片质量不 佳 |
| T | 人像引擎超时 |
| W | 该笔认证超时 |
| X | 未执行 |
| 第三字符:网证及认证码匹配比对 | 含义 |
|---|---|
| 0 | 网证状态正常 |
| 1 | 该居民身份证网证已被注销 |
| 2 | 该身份证没有申请居 民身份证网证 |
| 3 | 网证不匹配 |
| 4 | 认证码异常 |
| 5 | 该网证已经被冻结 |
| 6 | 身份信息不匹配 |
| 7 | 业务流水号为空 |
| 8 | 该网证已过期 |
| 9 | ID 验证数据为空 |
| J | 网证信息有误 |
| B | 下载设备 ID 不匹配 |
| C | 系统异常 |
| D | 该身份证已失效 |
| G | 数据库异常 |
| E | 系统异常 |
| X | 不执行 |