本文提供了调用图片同步检测任务进行活体翻拍检测的具体接口和参数说明,帮助您编写程序构建HTTP调用请求。
注意 活体翻拍检测的前提条件是图片中有人脸。建议您将该接口与敏感人脸识别功能组合使用。先调用敏感人脸识别接口进行图片人脸检测,在图片中检测到人脸后,再调用活体翻拍检测接口判断人脸是否为翻拍。更多信息,请参见敏感人脸识别。
使用说明
业务接口:/green/image/scan
您通过调用该接口提交图片同步检测任务,进行活体翻拍检测,检测图片中的活体对象(主要是人脸)来自直接拍摄或翻拍。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览。
该接口为收费接口。关于计费方式,请参见内容安全产品定价。
检测时长限制
同步检测允许的最长检测时间是6秒,如果检测在该时间限制内没有完成,系统会强制返回超时错误码。如果您对实时性要求不高,可以选择异步检测;其它情况下,请选择同步检测,同步检测接口的调用相对简单些。对于同步检测接口的调用,建议您将超时时间设置为6秒。
图片限制
- 图片链接支持以下协议:HTTP和HTTPS。
- 图片支持以下格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
- 图片大小限制为20 MB以内(适用于同步和异步调用),高度或者宽度不能超过30,000像素(px),且图像总像素不超过2.5亿(px)。
- 图片下载时间限制为3秒内,如果下载时间超过3秒,返回下载超时。
- 图片像素建议不低于256*256(px),像素过低可能会影响识别效果。
- 图片检测接口的响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云OSS存储或者CDN缓存等。
QPS限制
本接口的单用户QPS限制为50次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
请求参数
关于在请求中必须包含的公共请求参数,请参见公共参数。
请求body是一个JSON对象,字段说明如下。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
bizType | String | 否 | default | 该字段用于标识您的业务场景。您可以通过内容安全控制台创建业务场景(具体操作,请参见自定义机审标准)。 |
scenes | StringArray | 是 | ["liveness"] | 指定图片检测的应用场景,唯一取值:liveness。 |
tasks | JSONArray | 是 | 指定检测对象,JSON数组中的每个元素是一个检测任务结构体。最多支持100个元素,即每次提交100条内容进行检测,支持100个元素的前提是需要将并发任务调整到100个以上。关于每个元素的具体结构描述,请参见task。 |
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
dataId | String | 否 | test2NInmO$tAON6qYUrtCRgLo-1mwxdi | 数据ID。需要保证在一次请求中所有的ID不重复。 |
url | String | 是 | https://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png | 待检测图像的URL。 |
返回数据
关于返回结果说明,请参见返回结果。
返回body中的data字段是JSON数组,每一个元素包含如下字段。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Integer | 200 | 错误码,和HTTP状态码一致。
更多信息,请参见公共错误码。 |
msg | String | OK | 请求信息的响应消息。 |
dataId | String | test2NInmO$tAON6qYUrtCRgLo-1mwxdi | 对应请求中的dataId。 |
taskId | String | img2hsbmQeA4CU7l78$s8q5mW-1pnn7Z | 该检测任务的ID。 |
url | String | https://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png | 对应请求中的URL。 |
extras | Map | xxx | 附加信息。该值可能会调整,建议您不要在业务上进行依赖。 |
results | JSONArray | 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述见result。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
scene | String | liveness | 风险场景,唯一取值:liveness。 |
label | String | liveness | 检测结果的分类,取值:
|
suggestion | String | review | 建议用户执行的操作,取值范围:
|
rate | Float | 97.0 | 结果为该分类的概率,取值范围为0.00~100.00。值越高,表示越有可能属于该分类。 |
livenessData | JSONObject | 活体检测结果判断为翻拍(label=liveness)时,返回的活体检测信息。具体结构描述见livenessData。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
rate | Float | 97.0 | 活体照片属于翻拍的概率。分值越高,表示属于翻拍的概率越大。 |
示例
请求示例
http(s)://[Endpoint]/green/image/scan
&<公共请求参数>
{
"scenes": ["liveness"],
"tasks": [
{
"dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
"url": "https://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
}
]
}
返回示例
{
"code": 200,
"msg": "OK",
"requestId": "9EEF894F-A933-4830-97B1-EC1A9630A9D6",
"data": [{
"code": 200,
"dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
"taskId": "img2hsbmQeA4CU7l78$s8q5mW-1pnn7Z",
"url": "https://example.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png",
"msg": "OK",
"results": {
"label": "liveness ",
"rate": 97.0,
"scene": "liveness ",
"suggestion": "review",
"livenessData": {
"rate": 97.0
}
}
}]
}