接入文档
FaceID基础版
APP接入
API接口
加密说明
加密说明
# 1 加密说明
# 1.1 加密方案概述
为保护用户敏感信息不被泄露，在调用verify接口时，FaceID对接口传入参数和返回值中涉及用户信息的字符串和图片进行加密，加密规则如下:
# a. 接口传入参数加密
加密内容
| 接口 | 加密参数 | 说明 |
|---|---|---|
| verify | image | 用户传入的自有照片 |
| idcard_name | 需要核实对象的姓名 | |
| idcard_number | 需要核实的对象的证件号码 | |
| image_ref | 由应用方提供的参照人脸照片 |
# b. 接口返回值加密
加密内容
| 接口 | 加密参数 | 说明 |
|---|---|---|
| verify | images | 一组采集的用户照片，包括image_best |
# 1.2 如何开启加密
加密通过encryption_type字段进行配置
- 当encryption_type 配置为“0”时，不开启加密；
- 当encryption_type 配置为“3”时，使用国密SM4加密；
# 2 密钥配置
上传密钥
在控制台的应用配置中，点击信息加密后，输入SM4 KEY和IV，然后点击提交。
# 3 加解密示例说明
# 3.1 传入参数加密
# a. 加密对象
| 接口 | 加密参数 | 说明 |
|---|---|---|
| verify | idcard_name | 需要核实对象的姓名 |
| idcard_number | 需要核实的对象的证件号码 |
# 3.2 图片加密
# a. 加密对象
| 接口 | 加密参数 | 说明 |
|---|---|---|
| verify | image | 用户传入的自有照片 |
| image_ref | 由应用方提供的参照人脸照片 |
# 3.3 图片解密
# a. 解密对象
| 接口 | 加密参数 | 说明 |
|---|---|---|
| verify | images | 一组采集的用户照片，包括image_best |
该文档未解决您的疑问？
查看常见问题
查看常见问题