支持对台湾居民来往大陆通行证（台胞证）所有字段的自动定位与识别。
| 名称 | 内容 |
|---|---|
| 输入要求 | 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-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 | 接口名，取值：OcrTaibao |
| Version | 必选 | String | 版本号，取值：2021-08-23 |
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| 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。 |
请参考通用返回字段及错误码 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| license_main | main_info | 主页面信息 | 字段说明见下方 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| title | String | 证件名称 | 主页信息 |
| chn_name | String | 中文名 | 主页信息 |
| eng_name | String | 英文名 | 主页信息 |
| birth_date | String | 出生日期 | 主页信息 |
| sex | String | 性别 | 主页信息 |
| valid_date | String | 有效期限 | 主页信息 |
| register_office | String | 签发机关 | 主页信息 |
| register_address | String | 签发地点 | 主页信息 |
| num | String | 证件号码 | 主页信息 |
| register_count | String | 签发次数 | 主页信息 |
{ "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 | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 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" | 获取图片错误 |
| 400 | 61301 | "Invalid Input Parameters: Input image can not be decoded" | 输入图片错误 |