开发文档

1、静态活体检测

日期	版本	修订内容摘要
2024-01-16	v3.0.0	更新接口文档

1.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/json
URL	https://api.253.com/open/i/witness/face-check

1.2、请求参数

参数名	说明
appId	请在 https://chuanglan.com/ 登录后获取
appKey	请在 https://chuanglan.com/ 登录后获取
image	活体检测的自拍照片说明：imageType 为 URL 时，传入照片的网络 URL 地址 imageType 为 BASE64 时，传入照片的 base64 字符编码，base64 字符串不包含 data:image 前缀，支持图片类型：jpg/png/bmp，且图片大小不能大于 2M 图片分辨率说明：图片格式支持PNG、JPG、JPEG、BMP，不支持GIF图片，JPG格式图片长边像素不可超过4000，其他格式图片长边像素不可超过2000； 图片宽高比请接近3:4，手机拍摄比例最佳，人脸尺寸大于100*100像素
imageType	图片类型，枚举值：URL-图片路径 ,BASE64 –图片 BASE64 编码

1.3、响应参数说明

参数名	类型	说明
code	String	响应 code 码。200000：成功，其他失败。
message	String	响应 code 码解释
chargeStatus	String	是否收费，枚举值：1 ：收费 0：不收费
data	Object
tradeNo	String	交易号，唯一。样例：18041109215057630
checkStatus	String	检测结果，1 表示为活体，0 表示非活体
remark	String	检测说明
score	String	活体检测的分值，大于 87 分可判断为活体
code	String	活体检测返回码，0 表示成功，其他为失败

2、动态活体检测v2

2.1、协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
Content-Type	multipart/form-data
URL	https://api.253.com/open/i/htjc/lifecheck

2.2、请求参数

参数名	类型	是否必填	说明
appId	String	是	请在https://www.chuanglan.com/登录后获取
appKey	String	是	请在https://www.chuanglan.com/登录后获取
motions	String	是	用户动作序列:BLINK - 眨眼；MOUTH - 张嘴； NOD - 点头；YAW - 摇头
file	File	否	视频文件，适合本地文件上传，file和url二选一
url	String	否	视频文件地址，下载限时10秒，file和url二选一

参数名	参数值	备注
appId	abcdef	appId
appKey	123456	appKey
motions	BLINK	眨眼
url	https://chuanglan/xxx.mp4	文件url

2.3、响应参数说明

字段名	类型	说明
chargeStatus	int	是否收费，枚举值：1 ：收费 0：不收费
code	String	响应code码。 - 200000：成功 - 500000: 失败
message	String	响应code码解释
data	Object	返回对象
+result		结果
++face_image_url		活体成功之后，抓取的人脸照片
++hack_score		防hack检测分数，hack_score阈值为0.98，由行业大数据训练得到，大于0.98是hack行为，小于等于0.98是正常活人
++motions	Object	用户动作序列
+++score		单个动作分值 > 0.2表示通过，<= 0.2表示不通过
+++motion		用户动作序列
+++passed		单个动作检测结果
++passed		总体检测结果，true - 通过，false - 未通过
++desc		passed为false 活体检查失败的原因
+request_id		流水号

• 调用动态活体检测v2正常示例：

{
    "chargeStatus":1,
    "message":"成功",
    "data":{
        "result":{
            "face_image_url":"https://xxx.com/lifecheck-face/.jpg",
            "hack_score":0.49572145069739193,
            "motions":{
                "score":0.21902195717567044,
                "motion":"MOUTH",
                "passed":true
            },
            "passed":true,
            "desc":"检测通过"
        },
        "request_id":"079361799223192995591040"
    },
    "code":"200000"

}