接入文档![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
证件OCR识别![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
印尼身份证识别接入![](data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmVyc2lvbj0iMS4xIj4KIDxnIGZpbGw9IiM3MDcwNzgiPgogIDxwb2x5Z29uIHBvaW50cz0iOC4zOTc3NzgwMzQyMTAyMDUsMCA5LjQzNTgwMzg5MDIyODI3MSwwIDQuNzE3ODc3Mzg4MDAwNDg4LDEyIDMuNjg0MDMzMzkzODU5ODYzMywxMiAiLz4KIDwvZz4KPC9zdmc+Cg==)
API接入
API接入
# 描述
检测和识别印度尼西亚的身份证
# 调用URL
https://api-idn.megvii.com/faceid/v3/indonesia_ocr
注意:在生产环境中,请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路,存在安全风险,请勿在生产环境中使用。在生产环境中使用HTTP方式的,将无法得到服务可靠性保障。
# 调用方法
POST 注意:用form-data格式请求
接口说明
客户传入通过apikey和secret生成的加密签名sign,同时提供含有身份证的照片。我方返回身份证的识别结果。
此接口不包含质量检测功能,请客户自行保障传入图片的质量,图片出现质量问题可能导致无法识别身份证或某些字段无法识别。
# 参数
必选/可选 | 参数名 | 类型 | 参数说明 |
---|---|---|---|
必选 | sign | String | 调用此API客户的签名,具体的签名产生方式请查阅鉴权 |
sign_version | String | 签名算法版本号,请传递:hmac_sha1 | |
image | File | 客户方自行拍摄的含身份证的照片(客户需要自行保证照片质量,我方不进行质量检测) | |
可选 | biz_no | String | 本次业务的业务流水号 |
return_photo | String | 是否传回身份证头像照:
|
# 返回值
字段 | 类型 | 说明 |
---|---|---|
request_id | String | 用于区分每一次请求的唯一的字符串。除非发生404(API_NOT_FOUND)或 403 (AUTHORIZATION_ERROR)错误,剩余情况此字段必定返回。 |
time_used | Int | 整个请求所花费的时间,单位为毫秒。此字段必定返回。 |
biz_no | String | 传入的业务流水号,原封不动地返回 |
result | Int | 证件识别的结果码: (如图片中有多张证件,只返回证件号confidence值最高的一张证件信息)
|
idcard_face_image | String | 身份证上大头照,Base64编码 若未检测到人脸或人脸质量不合格,则返回null |
issued_province | Dict | 发卡省,识别成功返回; |
issued_city | Dict | 发卡市,识别成功返回; |
idcard_number | Dict | 证件号,识别成功返回; |
name | Dict | 姓名,识别成功返回; |
birth_place | Dict | 出生地,识别成功返回; |
birthday | Dict | 出生日期,识别成功返回; |
gender | Dict | 性别,识别成功返回; |
blood_type | Dict | 血型,识别成功返回; |
address_area | Dict | 地址,识别成功返回; |
address_building | Dict | 单元、楼号;识别成功返回; |
address_quarters | Dict | 小区,识别成功返回; |
address_districts | Dict | 街道,识别成功返回; |
faith | Dict | 宗教信仰,识别成功返回; |
marriage_type | Dict | 婚姻状态,识别成功返回; |
profession | Dict | 职业,识别成功返回; |
nationality | Dict | 国籍,识别成功返回; |
valid_end | Dict | 有效期,识别成功返回; |
issued_area | Dict | 发卡地(头像下地区信息),识别成功返回; |
valid_start | Dict | 签发时间,识别成功返回; |
card_rect | Dict | 按照结构体返回,里面会包含整张卡片四点坐标,具体返回示例如下: "rt"{ "x":324, "y":578 }// "lt"{ "x":324, "y":226 }// "lb"{ "x":398, "y":226 }// "rb"{ "x":398, "y":578 }// |
ERROR | String | 发生错误后,会返回对应的错误码,具体见下面 ERROR 错误信息 |
字段的结构体信息
字段 | 类型 | 值 |
---|---|---|
+result | String | 识别到的对应内容 |
+condifence | Float | 表示置信度,值为一个 [0,100] 的浮点数,小数点后 3 位有效数字; |
+rect | Dict | 返回字典结构,里面会包含区域的四点坐标,具体返回示例如下: "rt"{ "x":324, "y":578 }// "lt"{ "x":324, "y":226 }// "lb"{ "x":398, "y":226 }// "rb"{ "x":398, "y":578 }// |
# 错误信息
HTTP 状态代码 |
错误信息 | 说明 |
---|---|---|
400 | ID_CARD_NOT_FOUND | 图片中没有找到身份证,或因质量过差而无法识别。 |
400 | MISSING_ARGUMENTS: <key> | 缺少某个必要参数。 |
400 | BAD_ARGUMENTS: <key> | 某个参数解析出错(比如:必须是数字,但是输入的是字符串; 或者长度过长,或者照片无法解析)。 |
404 | API_NOT_FOUND | 所调用的API不存在。 |
403 | AUTHORIZATION_ERROR | 无效签名。 |
403 | AUTHORIZATION_ERROR: |
api_key被停用、调用次数超限、没有调用此API的权限或者没有以当前方式调用此API的权限。
|
403 | CONCURRENCY_LIMIT_EXCEEDED | 并发数超过限制 |
413 | Request Entity Too Large | 客户发送的请求单张照片大小超过了10MB限制。该错误的返回格式为纯文本,不是json格式。 |
500 | INTERNAL_ERROR | 服务器内部错误,当此类错误发生时请再次请求,如果一直出现此类错误,请及时联系FaceID客服。 |
该文档未解决您的疑问?
查看常见问题