You need to enable JavaScript to run this app.
导航
文字识别
  • 文档首页
    • /
  • 文字识别

调用方式

最近更新时间：2023.08.29 15:05:15

首次发布时间：2022.07.21 17:01:19

我的收藏
接口简介

支持对身份证中的文字进行检测和识别。同时提供身份证位置信息标记。

限制条件
名称内容
输入要求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-Typeapplication/x-www-form-urlencoded
是否需要鉴权是

请求参数

header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，文字识别一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

参数可选/必选类型说明
Action必选String接口名，取值：IDCard
Version必选String版本号，取值：2020-08-26

Body参数

参数可选/必选类型说明
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"
输出说明

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

version=v1 返回结构

data 字段说明

字段类型说明备注
card_frontfront_info正面信息正面信息字段说明见下方
card_backback_info背面信息背面信息字段说明见下方
card_cornersArray of Int身份证位置信息0点一般是左上角点，位置信息坐标为[左上、右上、右下、左下]。
注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float
quality_codeString关于身份证图像质量的提醒可能包含如下信息:
"00": 正常
输入图片质量问题：
"01"："输入图片无身份证内容",
"02"： "输入图片内身份证不完整",
"03"： "身份证关键信息有遮挡、身份证图片质量差",
非正常身份证类型：
"04"： "检测到当前身份证为身份证复印件",
"05"： "检测到当前身份证为屏幕翻拍",
"06"："检测到当前身份证为临时身份证",
"07"："检测到当前身份证有其他风险"
"08"： "其他问题"

front_info 字段说明

字段类型说明备注
nameString姓名正面信息
genderString性别正面信息
ethnicityString民族正面信息
data_of_birthString出生日期（YYYY.MM.DD）正面信息
domicileString住址正面信息
id_numberString公民身份号码正面信息
face_cornersArray of Int身份证人脸位置信息正面信息
注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float

back_info 字段说明

字段类型说明备注
issue_authorityString签发机关背面信息
valid_periodString有效期限（YYYY.MM.DD-YYYY.MM.DD）背面信息

version=v2 返回结构

data 字段说明

字段类型说明备注
card_frontfront_info正面信息图片内不含正面证件时内容为空
card_backback_info背面信息图片内不含背面证件时内容为空
quality_codeString关于身份证图像质量的提醒可能包含如下信息:
"00": 正常
输入图片质量问题：
"01"："输入图片无身份证内容",
"02"： "输入图片内身份证不完整",
"03"： "身份证关键信息有遮挡、身份证图片质量差",
非正常身份证类型：
"04"： "检测到当前身份证为身份证复印件",
"05"： "检测到当前身份证为屏幕翻拍",
"06"："检测到当前身份证为临时身份证",
"07"："检测到当前身份证有其他风险"
"08"： "其他问题"

front_info 字段说明

字段类型说明备注
nameString姓名正面信息
genderString性别正面信息
ethnicityString民族正面信息
data_of_birthString出生日期（YYYY.MM.DD）正面信息
domicileString住址正面信息
id_numberString公民身份号码正面信息
face_cornersArray of Int身份证人脸位置信息正面信息
注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float
card_cornersArray of Int身份证位置信息注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float
card_imgString身份证图片Base64值
face_imgString人脸图片Base64值
card_typeString证件类型“真实身份证”、“身份复印件”、“屏幕翻拍”、“临时身份证”、“其他”

back_info 字段说明

字段类型说明备注
issue_authorityString签发机关背面信息
valid_periodString有效期限（YYYY.MM.DD-YYYY.MM.DD）背面信息
card_cornersArray of Int身份证位置信息注意: 输入是PDF文件时，以相对坐标的形式返回，Array of Float
card_imgString身份证图片Base64值
card_typeString证件类型“真实身份证”、“身份复印件”、“屏幕翻拍”、“临时身份证”、“其他”

输出示例

正面图片返回值示例

{
    "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错误码错误消息描述
20010000无请求成功
40050205"Image Size Exceeds Maximum Limit: please compress the image"输入文件过大
40050206"Invalid Input Image: image is empty"输入图片为空
40050207"Image Decode Error: image format unsupported"图片解码错误
40050217"Process PDF File Error."处理PDF文件错误
40060103Missing Input Parameters: empty input image输入图片为空
40060301Invalid Input Image: get input image error输入图片错误