证件照合规性检测接口 #
地址:https://www.clipimg.com/api/idphoto/check
请求方式:POST
数据类型:JSON
响应类型:JSON
计费:1点每次调用
接口描述:此接口为证件照合规性检测
参数[Header]
| 参数名 | 说明 | 是否必选 | 类型 |
| X-API-Key | 秘钥,点此获取 | 必选 | string |
| Content-Type | 请求数据类型 | 必选 | application/json |
参数[Body]:
| 参数名 | 说明 | 是否必选 | 类型 |
| file | 图片的base64格式,不包含base64的头部数据 | 必选 | string |
| spec_id | 规格id | 可选,width、height不传值时必传 | int |
| width | 宽度px | 可选,spec_id不传值时必传 | int |
| height | 高度px | 可选,spec_id不传值时必传 | int |
| facepose | 人脸是否正对摄像头误差偏移的度数范围,检测人脸pitch、yaw、roll三项误差值,示例 | 可选,示例:20,取值0-180度。人脸角度容差(度数)。建议设置:15-30°(允许轻微偏转)、5-15°(严格要求),超出设定角度的照片将被标记为不合规,设置为0表示不检测角度 | float |
| face_ratio_min | 检测头部最小比例 | 可选 | float |
| face_ratio | 检测头部最大比例 | 可选 | float |
| dpi | 检测证件照分辨率 | 可选,示例:72、96、300 | int |
| head_top_gap_ratio | 检测头顶发迹离上边缘距离 | 可选 | float |
| eyes_to_botttom_ratio_min | 检测眼睛离下边缘最小距离 | 可选 | float |
| glasses_glare | 是否进行眼镜炫光检测 | 可选,0表示不检测,1表示检测 | int |
| file_format | 检测照片格式 | 可选,jpg、png | string |
| head_height_ratio_max | 检测头部高度占比最大值 | 可选,示例值:0.7 | float |
| head_height_ratio_min | 检测头部高度占比最小值 | 可选,示例值:0.5 | float |
| eye_distance_ratio_max | 检测眼间距宽度占比最大值 | 可选,示例值:0.4 | float |
| eye_distance_ratio_min | 检测眼间距宽度占比最小值 | 可选,示例值:0.3 | float |
| hat_check | 检测帽子 | 可选,1:检测,0:不检测 | int |
| glasses_check | 检测眼镜 | 可选,1:检测,0:不检测 | int |
| necklace_check | 检测项链 | 可选,1:检测,0:不检测 | int |
| earring_check | 检测耳环 | 可选,1:检测,0:不检测 | int |
| contrast_min | 对比度检测 | 可选,最低对比度要求。 推荐范围: • 宽松要求:20-40(适用于普通应用) • 标准要求:40-80(推荐证件照) • 严格要求:80-150(高质量要求) • 超严格:>150(专业摄影级别) 设置为0表示不检测对比度 | float |
| brightness_check_min | 亮度检测 | 可选,0:不检测,最低亮度值。 推荐范围: • 宽松要求:80-120(光线较暗环境) • 标准要求:100-130(推荐证件照) • 严格要求:110-140(高质量要求) 设置为0表示不检测最低亮度 | float |
| brightness_check_max | 亮度检测 | 可选,最高亮度值。 推荐范围: • 宽松要求:200-220(允许轻微过曝) • 标准要求:170-190(推荐证件照) • 严格要求:160-180(高质量要求) 设置为255表示不检测最高亮度 | float |
| gaze_check | 检测视线 | 可选,1:检测,0:不检测 | int |
| eye_blink_check | 检测闭眼 | 可选,1:检测,0:不检测 | int |
| mouth_neutral_check | 检测嘴部表情 | 可选,1:检测,0:不检测 | int |
| file_size_min | 检测文件范围最大值 | 可选,1:检测,0:不检测 | float |
| file_size_max | 检测文件范围最小值 | 可选,1:检测,0:不检测 | float |
| sunglasses_check | 检测墨镜 | 可选,1:检测,0:不检测 | int |
| bg_colors | 检测背景色,支持红底、蓝底、白底检测 | 可选,eg:[‘red’,’white’,’blue’] | list |
| mouth_open_check | 检测张嘴 | 可选,1:检测,0:不检测 | int |
| brow_check | 检测眉毛遮挡 | 可选,1:检测,0:不检测 | int |
| eye_check | 检测眼睛遮挡 | 可选,1:检测,0:不检测 | int |
| ear_check | 检测耳朵遮挡 | 可选,1:检测,0:不检测 | int |
| nose_check | 检测鼻子遮挡 | 可选,1:检测,0:不检测 | int |
| mouth_check | 检测嘴巴遮挡 | 可选,1:检测,0:不检测 | int |
| solid_bg_check | 检测纯色背景 | 可选,1:检测,0:不检测 | int |
| bg_shadow_check | 检测背景阴影 | 可选,1:检测,0:不检测 | int |
| neck_shadow_check | 检测脖子阴影 | 可选,1:检测,0:不检测 | int |
| bg_clothes_similar_check | 检测背景服装相似 | 可选,1:检测,0:不检测 | int |
| shirtless_check | 检测光膀 | 可选,1:检测,0:不检测 | int |
| head_crop_check | 检测头部是否完整 | 可选,1:检测,0:不检测 | int |
| cheek_full_check | 检测脸颊遮挡 | 可选,1:检测,0:不检测 | int |
| image_noise_check | 检测照片噪声 | 可选,1:检测,0:不检测 | int |
| thick_frame_glasses_check | 检测粗框眼镜 | 可选,1:检测,0:不检测 | int |
| facemask_check | 检测口罩 | 可选,1:检测,0:不检测 | int |
| shoulder_check | 肩膀缺失检测 | 可选,1:检测,0:不检测 | int |
| horizontal_shoulder_check | 肩膀水平检测 | 可选,1:检测,0:不检测 | int |
| body_pose_check | 检测身体姿态 | 可选,1:检测,0:不检测 | int |
| face_balanced_light_check | 检测阴阳脸 | 可选,1:检测,0:不检测 | int |
| face_clarity_check | 脸部模糊检测 | 可选,1:检测,0:不检测 | int |
| color_cast_check | 偏色检测 | 可选,1:检测,0:不检测 | int |
返回:
| 参数 | 说明 | 示例 | 类型 |
| code | 状态码 | 0 | int |
| msg | 错误详情 | 成功 | string |
| data | 结果 |
code取值
| 0 | 请求成功 |
| 400 | 参数错误 |
| 401 | 照片格式有误 |
| 402 | 点数已用完 |
| 407 | 未检测到人脸 |
| 416 | 处理超时 |
data结构体
| 参数名 | 说明 | 类型 |
| check_info | 所检测项目的值 | list |
| check_result | 检测结果 | list |
data示例:
JSON
{
"check_result": [
{
"key": "pic_height_check",// 键值
"check": 0, // 0:未通过,1:通过
"name": "照片高度检测" // 检测项目
},
{
"key": "pic_width_check",
"check": 0,
"name": "照片宽度检测"
},
{
"key": "eye_center_check",
"check": 1,
"name": "双眼中心在画面正中心检测"
}
],
"check_info": [
{
"key": "head_pitch",// 键值
"value": 14.82,// 检测值
"name": "头部上下抬头偏移角度"// 检测项目
},
{
"key": "head_yaw",
"value": 0.26,
"name": "头部前后旋转偏移角度"
},
{
"key": "head_roll",
"value": 0.62,
"name": "头部左右偏头偏移角度"
},
{
"key": "pic_w",
"value": 914,
"name": "照片宽度"
},
{
"key": "pic_h",
"value": 1280,
"name": "照片高度"
},
{
"key": "eye_center",
"value": 0.5,
"name": "双眼中心在画面比例"
},
{
"key": "file_size",
"value": 499.74,
"name": "文件大小(kb)"
},
{
"key": "file_type",
"value": "jpeg",
"name": "照片格式"
},
{
"key": "dpi",
"value": 96.0,
"name": "dpi"
}
]
}