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

调用方式

最近更新时间：2023.04.06 16:20:04

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

我的收藏
接口简介

支持对台湾居民来往大陆通行证（台胞证）所有字段的自动定位与识别。

限制条件
名称内容
输入要求1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。
2. 文件大小：
a.要求Base64编码和urlencode之后不超过 8 MB。
b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。
3. 输入文件过大时，返回的HttpCode如下：400/413/502。
4. 输入多页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接口名，取值：OcrTaibao
Version必选String版本号，取值：2021-08-23

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String台胞证图片文件，base64编码
注意: 只需要传图片的base64值，类似data:image/png;base64的图片头不要传入
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。
输出说明

通用输出参数

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

业务输出参数

data 字段说明

字段类型说明备注
license_mainmain_info主页面信息字段说明见下方

main_info 字段说明

字段类型说明备注
titleString证件名称主页信息
chn_nameString中文名主页信息
eng_nameString英文名主页信息
birth_dateString出生日期主页信息
sexString性别主页信息
valid_dateString有效期限主页信息
register_officeString签发机关主页信息
register_addressString签发地点主页信息
numString证件号码主页信息
register_countString签发次数主页信息

输出示例

主页面图片返回值示例

{
   "code":10000,
   "data":{
      "license_main":{
         "title":"台湾居民来往大陆通行证",
         "chn_name":"证件样才",
         "eng_name":"ZHENG-JIAN,",
         "birth_date":"1981.08.03",
         "sex":"女",
         "valid_date":"2015.06.09-2020.06.08",
         "register_office":"公安部出入境管理局",
         "register_address":"福建",
         "num":"00000000",
         "register_count":"01"
      }
   },
   "message":"Success",
   "request_id":"69060562706382213251607941527",
   "status":10000,
   "time_elapsed":"481.956877ms"
}
错误码

通用错误码

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

业务错误码

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文件错误
40060103"Missing Input Parameters: empty input image"输入图片为空
40060301"Invalid Input Image: get input image error"获取图片错误
40061301"Invalid Input Parameters: Input image can not be decoded"输入图片错误