支持对身份证中的文字进行检测和识别。同时提供身份证位置信息标记。
| 名称 | 内容 |
|---|---|
| 输入要求 | 1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。 2. 图片像素尺寸： a. 最小 256 x 256 像素，最大 2048 x 2048 像素。 b.为了保证文字识别效果，推荐图片中身份证最短边长不低于256像素，且整张图片长宽比在合理范围内。 3.文件大小： a.要求Base64编码和urlencode之后不超过 8 MB。身份证主体尽量占据图片主要区域，不支持黑白图片。 b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。 4. 输入文件过大时，返回的HttpCode如下：400/413/502。 5. 注意图片质量： a. 保证身份证图片足够清晰，不应该有因为压缩导致的噪声，避免对身份证正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。 b.如使用双面识别(version=v2)，请尽可能保证身份证正反区域在图中占比需大于30%，否则会降低结果准确度 6. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。 7. 输入多页PDF时，默认只识别第一页。 |
| 名称 | 内容 |
|---|---|
| 接口地址 | https://visual.volcengineapi.com |
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
| 是否需要鉴权 | 是 |
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| X-Date | String | 是 | 使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z |
Authorization | String | 是 | HMAC-SHA256：签名方法 |
| X-Security-Token | String | 否 | 指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。 |
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：IDCard |
| Version | 必选 | String | 版本号，取值：2020-08-26 |
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| image_base64 | 与image_url二选一 | String | 图片/PDF文件，base64编码 注意: 只需要传图片/PDF的base64值，类似data:image/png;base64的图片头不要传入 |
| image_url | 与image_base64二选一 | String | 图片/PDF文件的URL链接 注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。 |
| version | 可选 | String | 身份证服务版本, 可选"v1"/"v2", 默认为"v1" |
请参考通用返回字段及错误码 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| card_front | front_info | 正面信息 | 正面信息字段说明见下方 |
| card_back | back_info | 背面信息 | 背面信息字段说明见下方 |
| card_corners | Array of Int | 身份证位置信息 | 0点一般是左上角点，位置信息坐标为[左上、右上、右下、左下]。 注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float |
| quality_code | String | 关于身份证图像质量的提醒 | 可能包含如下信息: "00": 正常 输入图片质量问题： "01"："输入图片无身份证内容", "02"： "输入图片内身份证不完整", "03"： "身份证关键信息有遮挡、身份证图片质量差", 非正常身份证类型： "04"： "检测到当前身份证为身份证复印件", "05"： "检测到当前身份证为屏幕翻拍", "06"："检测到当前身份证为临时身份证", "07"："检测到当前身份证有其他风险" "08"： "其他问题" |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| name | String | 姓名 | 正面信息 |
| gender | String | 性别 | 正面信息 |
| ethnicity | String | 民族 | 正面信息 |
| data_of_birth | String | 出生日期（YYYY.MM.DD） | 正面信息 |
| domicile | String | 住址 | 正面信息 |
| id_number | String | 公民身份号码 | 正面信息 |
| face_corners | Array of Int | 身份证人脸位置信息 | 正面信息 注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| issue_authority | String | 签发机关 | 背面信息 |
| valid_period | String | 有效期限（YYYY.MM.DD-YYYY.MM.DD） | 背面信息 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| card_front | front_info | 正面信息 | 图片内不含正面证件时内容为空 |
| card_back | back_info | 背面信息 | 图片内不含背面证件时内容为空 |
| quality_code | String | 关于身份证图像质量的提醒 | 可能包含如下信息: "00": 正常 输入图片质量问题： "01"："输入图片无身份证内容", "02"： "输入图片内身份证不完整", "03"： "身份证关键信息有遮挡、身份证图片质量差", 非正常身份证类型： "04"： "检测到当前身份证为身份证复印件", "05"： "检测到当前身份证为屏幕翻拍", "06"："检测到当前身份证为临时身份证", "07"："检测到当前身份证有其他风险" "08"： "其他问题" |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| name | String | 姓名 | 正面信息 |
| gender | String | 性别 | 正面信息 |
| ethnicity | String | 民族 | 正面信息 |
| data_of_birth | String | 出生日期（YYYY.MM.DD） | 正面信息 |
| domicile | String | 住址 | 正面信息 |
| id_number | String | 公民身份号码 | 正面信息 |
| face_corners | Array of Int | 身份证人脸位置信息 | 正面信息 注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float |
| card_corners | Array of Int | 身份证位置信息 | 注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float |
| card_img | String | 身份证图片Base64值 | |
| face_img | String | 人脸图片Base64值 | |
| card_type | String | 证件类型 | “真实身份证”、“身份复印件”、“屏幕翻拍”、“临时身份证”、“其他” |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| issue_authority | String | 签发机关 | 背面信息 |
| valid_period | String | 有效期限（YYYY.MM.DD-YYYY.MM.DD） | 背面信息 |
| card_corners | Array of Int | 身份证位置信息 | 注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float |
| card_img | String | 身份证图片Base64值 | |
| card_type | String | 证件类型 | “真实身份证”、“身份复印件”、“屏幕翻拍”、“临时身份证”、“其他” |
{ "code":10000, "data":{ "card_front":{ "name":"字节跑动", "gender":"男", "ethnicity":"汉", "data_of_birth":"1990.01.01", "domicile":"滨江市海滨区西知春路00号", "id_number":"102030199004444444", "face_corners":[183,65,232,65,232,131,183,131] } "card_back":{ "issue_authority":"", "valid_period":"" }, "card_corners":[0,14,254,17,255,192,0,192] "quality_code": "00" }, "message":"Success", "request_id":"6838889517957515275", "time_elapsed":"41.897331ms" }
{ "code":10000, "data":{ "card_front": { "name": "", "gender": "", "ethnicity": "", "data_of_birth": "", "domicile": "", "id_number": "" }, "card_back":{ "issue_authority":"北京市海淀区公安局", "valid_period":"2020.01.01-2030.01.01" }, "card_corners":[0,14,254,17,255,192,0,192] "quality_code": "00" }, "message":"Success", "request_id":"6838889517957544315", "time_elapsed":"36.875321ms" }
请参考通用返回字段及错误码
| HttpCode | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 200 | 10000 | 无 | 请求成功 |
| 400 | 50205 | "Image Size Exceeds Maximum Limit: please compress the image" | 输入文件过大 |
| 400 | 50206 | "Invalid Input Image: image is empty" | 输入图片为空 |
| 400 | 50207 | "Image Decode Error: image format unsupported" | 图片解码错误 |
| 400 | 50217 | "Process PDF File Error." | 处理PDF文件错误 |
| 400 | 60103 | Missing Input Parameters: empty input image | 输入图片为空 |
| 400 | 60301 | Invalid Input Image: get input image error | 输入图片错误 |