权威版人脸识别接口文档


1.接口说明

名称 说明
协议 HTTPS POST
地址 https://api.cxlnk.com/api/safFace/faceH5Certification
Accept application/json
Content-Type application/json;charset=utf-8

2.请求参数说明

响应 body 数据为 JSON 格式

列表 内容 备注
accessKey API调用账号(必填,String类型,从灿星云平台获取)
accessSecret API调用密钥(必填,String类型,从灿星云平台获取)
idNo 身份证号码(必填)
name 姓名(必填)
returnUrl 认证成功后重定向地址(必填,需要加上协议头)

3.请求参数示例

{
 "accessKey": "NDYw*******",
 "accessSecret": "MDQyOTQ1OTM3*********************",
 "idNo":"341225****",
 "name":"李明",
 "returnUrl": "https://www.*.com"
}
					

4.响应参数列表

列表 内容
code 状态码200则为成功
msg 状态说明
success 处理是否成功:取值范围 true,false
data 业务数据 如果失败则为空
certifyId 流水号id用于获取人脸识别结果的表示
reqNo 业务唯一标识

5.响应参数示例

{
 "code": 200,
 "msg": "认证通过",
 "success": true,
 "data": { 
          "certifyUrl": "https://ur.alip*******",
		  "certifyId": "a*****"
		  "reqNo": "A1****"
    }
}
						

6.结果码说明

结果码 描述
200 成功
500,501,503 系统错误
502 系统繁忙
60021 余额不足,请充值后重试!
10000 内部系统出错,请联系厂商

7.获取人脸识别接口结果

名称 说明
协议 HTTPS POST
地址 https://api.cxlnk.com/api/safFace/faceH5CertificationResult
Accept application/json
Content-Type application/json;charset=utf-8

8.请求参数说明

响应 body 数据为 JSON 格式

列表 内容
accessKey API调用账号(必填,String类型,从灿星云平台获取)
accessSecret API调用密钥(必填,String类型,从灿星云平台获取)
certifyId 流水号,请求人脸识别接口接口返回消息体的certifyId

9.请求参数示例

{
 "accessKey": "87d03*****",
 "accessSecret": "b20d7*****",
 "certifyId": "a123*****"
}
										

10.响应参数列表

列表 内容
code 状态码200则为成功
msg 状态说明
success 处理是否成功:取值范围 true,false
data 业务数据 如果失败则为空
materialInfo 信息
samePerson 人脸比对结果
-true(T) 同一人
-false (F)不同人
riskInterceptionType 人脸比对结果
-LIVENESS_NOT_PASS 基础活体拦截
-STRATEGY_NOT_PASS 组合策略拦截
-NONE 未拦截
-UNKNOWN 未知原因
scoreNormalized 0-100分,分数越高相似度越高,请联系您的客户经理获取阈值
attributes 人脸性别年龄预估
gender 性别
-male 男性
-female 女性
age 年龄
faceAttack 是否是攻击
-true 是攻击
-false 不是攻击
faceOcclusion 面部是否遮挡
-true 存在遮挡
-false 没有遮挡或仅有小部分遮挡
h5DegradeFlag WEB降级标
-true 有降级
-false 没有降级
quality 综合质量分
0-100分,分数越高质量越好,请联系您的客户经理获取阈值
fee 是否收费:0不收费,1收费
passed 认证是否通过
-true(T) 通过
-false (F)未通过

11.响应参数示例

{
 "code": 200,
 "msg": "操作成功",
 "success": true,
 "data": {
	      "materialInfo": {
	        "samePerson": "F",
	        "riskInterceptionType": "NONE",
	        "scoreNormalized": "54.341607639293",
	        "attributes": {
	          "gender": "male",
	          "age": 49
	         },
	        "faceAttack": false,
	        "faceOcclusion": false,
	        "h5DegradeFlag": "false",
	        "quality": 100.0
	       },
	        "fee": 1,
	        "passed": "F"
    }
}
											

12.结果码说明

结果码 描述
200 成功
500,501,503 系统错误
502 系统繁忙
60021 余额不足,请充值后重试!
10000 内部系统出错,请联系厂商