支持检测图片中的银行卡,准确地返回银行卡的结构化信息。提供两个不同版本,V1只提供卡号信息,V2提供卡号信息、过期时间、银行信息等扩充内容。
名称 | 内容 |
---|---|
输入要求 | 1. 文件格式:支持JPG、JPEG、PNG、BMP、PDF等常见格式,建议使用JPG格式。 2. 图片像素尺寸:最小 256 x 256 像素,最大 2048 x 2048 像素。为了保证文字识别效果,推荐图片中银行卡最短边长不低于256像素。 3. 文件大小: a.要求Base64编码和urlencode之后不超过 8 MB。银行卡主体尽量占据图片主要区域,不支持黑白图片。 b.如果传图片及PDF完整URL,URL对应文件大小建议不要超过8MB。 4. 输入文件过大时,返回的HttpCode如下:400/413/502。 5. 注意图片质量:保证银行卡图片足够清晰,不应该有因为压缩导致的噪声,避免对银行卡的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。 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 | 接口名,取值:BankCard |
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_number | string | 银行卡号 | |
card_corners | corner_info | 卡号位置信息 | 卡号在图片中的位置 |
输入图片文件时,返回字段说明:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
left_top | Array of Int | 左上坐标 | |
right_top | Array of Int | 右上坐标 | |
right_bottom | Array of Int | 右下坐标 | |
left_bottom | Array of Int | 左下坐标 |
输入PDF文件时,返回字段说明:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
left_top | Array of Float | 左上坐标 | 相对坐标形式 |
right_top | Array of Float | 右上坐标 | 相对坐标形式 |
right_bottom | Array of Float | 右下坐标 | 相对坐标形式 |
left_bottom | Array of Float | 左下坐标 | 相对坐标形式 |
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
expired_date | String | 过期时间 | |
expired_date_corners | Corner | 过期时间在图片中的4个顶点坐标 | 字段说明见下方 |
number | String | 卡号 | |
number_corners | Corner | 卡号在图片中的4个顶点坐标 | 字段说明见下方 |
bank_id | String | 银行编号 | 识别失败返回空字符串 |
bank_name | String | 银行名称 | 识别失败返回空字符串 |
card_name | String | 卡名称 | 识别失败返回空字符串 |
card_type | String | 卡类型 | 借记卡、贷记卡、预付费卡、准贷记卡等 |
输入图片文件时,返回字段说明:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
left_top | list | 顶点坐标 [x, y] | |
right_top | list | 顶点坐标 [x, y] | |
right_bottom | list | 顶点坐标 [x, y] | |
left_bottom | list | 顶点坐标 [x, y] |
输入PDF文件时,返回字段说明:
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
left_top | list | 顶点坐标 [x, y] | 相对坐标形式 |
right_top | list | 顶点坐标 [x, y] | 相对坐标形式 |
right_bottom | list | 顶点坐标 [x, y] | 相对坐标形式 |
left_bottom | list | 顶点坐标 [x, y] | 相对坐标形式 |
{ "code": 10000, "data": { "card_corners": { "left_top": [118,183], "right_top": [480,183], "right_bottom": [480,211], "left_bottom": [117,210] }, "card_number": "622262 8888888888888" }, "message": "Success", "request_id": "6838889517957515275", "status": 10000, "time_elapsed": "26.22071ms" }
{ "code": 10000, "data": { "bank_id": "03010000", "bank_name": "交通银行", "card_name": "交银IC卡", "card_type": "借记卡", "expired_date": "8888/88", "expired_date_corners": { "left_top": [267,235], "right_top": [349,235], "right_bottom": [349,254], "left_bottom": [267,254] }, "number": "6222628888888888888", "number_corners": { "left_top": [119,183], "right_top": [479,184], "right_bottom": [480,212], "left_bottom": [119,211] } }, "message": "Success", "request_id": "6838889517957515275", "status": 10000, "time_elapsed": "69.846205ms" }
请参考通用返回字段及错误码
v1版本返回状态码:
HttpCode | 错误码 | 错误消息 | 描述 |
---|---|---|---|
200 | 10000 | 无 | 请求成功 |
400 | 50217 | "Process PDF File Error." | 处理PDF文件错误 |
400 | 60103 | "Missing Input Parameters: empty input image" | 输入图片为空 |
400 | 61201 | "Invalid Input Parameters: get input image error" | 获取图片错误 |
400 | 61202 | "Bank Card OCR Error" | 银行卡OCR识别错误 |
400 | 61203 | "Invalid Input Parameters: No bank card detected in input image" | 未检测到银行卡 |
v2版本返回状态码:
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 | 61203 | "Invalid Input Parameters: No bank card detected in input image" | 未检测到银行卡 |