接入文档
海外证件防伪接口
海外证件防伪接口
海外证件防伪接口
# 描述
该接口可以检测海外证件的真伪,目前支持墨西哥选民证,伪造类型支持翻拍检测。
# 调用方法
- 请求路径:
/faceid/v5/overseas_id_verification
- 请求方法:
POST
- 请求参数:
content-type: Multipart/Form-Data
参数名称 | 数据类型 | 是否必填 | 说明 | 示例值 |
---|---|---|---|---|
sign |
string | 是 | ||
sign_version |
string | 是 | hmac_sha1 |
|
image |
file | 是 | 一个图像,二进制文件,需使用 Multipart/Form-Data 的方式上传。注:要求文件大小小于 10MB,支持最小分辨率 200×200,最大 8000×8000。 |
|
doc_type |
string | 是 | 证件类型(当前固定为 mexico_voter_id ,未来可扩展) |
mexico_voter_id |
# 返回值
content-type:application/json
参数名称 | 数据类型 | 说明 | 示例值 |
---|---|---|---|
request_id |
string | 用于区分每一次请求的唯一的字符串。除非发生404(API_NOT_FOUND)或 403 (AUTHORIZATION_ERROR)错误,此字段必定返回 | |
time_used |
int | 整个请求所花费的时间,单位为毫秒,除非发生404(API_NOT_FOUND)或 403 (AUTHORIZATION_ERROR)错误,此字段必定返回 | |
forge_data |
json object | 结果详细数据,包括最终检测结果:is_forged,以及各种伪造类型的置信度。 | 见下方示例 |
error |
string | 发生错误后,会返回对应的错误码,具体见下面 ERROR 错误信息 |
# forge_data
参数示例
{
"is_forged": true,
"attack_info": {
"screen": 0.93
}
}
# forge_data
结构
字段名称 | 数据类型 | 说明 | 示例值 |
---|---|---|---|
is_forged |
boolean | 是否为伪造证件(true为伪造,false为正常) | true |
attack_info |
json object | 伪造类型及置信度 |
# 返回示例
{
"request_id": "1751535373,27967427-41ea-41e9-83ab-e8fa5f688b21",
"time_used": 255,
"forge_data": {
"is_forged": false,
"attack_info": {
"screen": 0.42483786
}
}
}
# 错误信息
错误信息 | 说明 | 解决方案 |
---|---|---|
IMAGE_ERROR_UNSUPPORTED_FORMAT |
图片解码失败 | |
INVALID_IMAGE_SIZE:<param> |
图片尺寸过大或过小 | |
DOC_TYPE_NOT_SUPPORT |
证件类型不支持 | 确认 doc_type 为 mexico_voter_id |
INTERNAL_ERROR |
服务器内部错误 | 稍后重试或联系技术支持 |
该文档未解决您的疑问?
查看常见问题