活体检测/核身/比对-获取单据号

---

接口描述

进行活体检测前，需要获取单据号，作为本次活体识别的唯一凭证。

进行接口调用前，需要获取必要的token信息，可查看登录鉴权。 该接口为加密接口，可查看签名与加密方式配置加密秘钥，并对接口内容进行加密。

请求说明

HTTP 方法:

POST

请求 URL：

/kaleidoscope-live/live/antispoof/v2/getCertify

Header如下：

参数名称	值
Content-Type	application/json;charset=UTF-8

Body中放置请求参数，参数详情如下：

请求参数：

参数名称	必填	数据类型	长度	参数描述
actionScene	否	String	1-32	动作场景枚举， 不传默认为EC（眨眼+光线）
planCode	否	String	1-255	活体方案Code,若同时传入方案id与场景枚举，则场景枚举设置的动作生效
busFlowId	否	String	0-64	业务流水号，业务系统唯一序列号（对账用，建议传入）
cId	否	String	1-32	身份证号码 若通过平台自定义活体方案将“比对源设置”为“权威数据库比对”，且“身份信息录入方式”设置为“调用接口时传入身份信息”则必传，其他情况为非必传
cName	否	String	1-32	姓名 若通过平台自定义活体方案将“比对源设置”为“权威数据库比对”，且“身份信息录入方式”设置为“调用接口时传入身份信息”则必传，其他情况为非必传
img	否	String	1-3000k	比对图片(base64 编码)，原始图片大小需要小于 3M; 若通过平台自定义活体方案将“比对源设置”为“与自传照片比对”，且“身份信息录入方式”设置为“调用接口时传入”则必传，其他情况为非必传

请求示例：

{
    "actionScene":"EC",
    "planCode":"965575176974721027",
    "busFlowId":"035143d350c646f68f4d25e44ff426c3"
}

返回说明

返回参数：

返回值名称			数据类型	长度	描述
code			int	1-8	返回结果，00000000表示成功
message			String	1-255	返回码描述
data			Object	-	返回的数据
	-certifyId		String	1-32	单据号
	-busFlowId		String	-	业务流水号
	-sdkInfo		Object	-	Sdk信息，需要在平台自定义活体方案中维护，否则返回为空
		--platformType	IntegerArray[]	-	开发平台 1 iOS 2Android 3 HarmoneyOS
		--iosPackageName	String	-	ios包名
		--androidPackageName	String	-	安卓包名
		--harmonyPackageName	String	-	鸿蒙包名

返回示例：

{
    "code": "00000000",
    "success": true,
    "message": "success",
    "data": {
        "certifyId": "1004824012104138752",
        "busFlowId": "035143d350c646f68f4d25e44ff426c3",
        "sdkInfo": {
            "platformType": [
                1,
                2,
                3
            ],
            "iosPackageName": "iosPackageName",
            "androidPackageName": "androidPackageName",
            "harmonyPackageName": "harmonyPackageName"
        }
    }
}

动作场景枚举

actionScene	描述
EC	光线眨眼
RANDOM	随机3动作，(局部[眨眼E、张嘴M] + 全脸[左转L、右转R] + 光线C)
OEC	远近眨眼光线

错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共CODE码表

码值	是否成功	是否计费	描述
00000000	是	否	成功
80002907	否	否	场景码有误
80003063	否	否	应用下不存在该方案
80003065	否	否	方案场景、比对类型不符
80003504	否	否	获取单据号异常
50029800	否	否	图片不能为空
50029811	否	否	证件号不能为空
50029813	否	否	证件姓名不能为空