You need to enable JavaScript to run this app.
导航

接口文档

最近更新时间2022.06.13 14:24:20

首次发布时间2021.12.16 13:59:15

接入指引

请先查看接入指引了解具体接入方式,再参考此文档完成接入。

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded
图片要求1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。
2. 图片像素尺寸:最小 256 x 256 像素,最大 2048 x 2048 像素。为了保证文字识别效果,推荐图片中银行卡最短边长不低于256像素。
3. 图片文件大小:最大 5 MB。银行卡主体尽量占据图片主要区域,不支持黑白图片。
4. 注意图片质量:保证银行卡图片足够清晰,不应该有因为压缩导致的噪声,避免对银行卡的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。
5. 图片需要有版权,有肖像权,没有法律或者政策风险的。相关风险请注意评估。
6. 银行卡图片不可以是复印件、翻拍件、PS件等。

输入参数

Query参数:

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

Body参数:

参数可选/必选类型说明
image_base64必选String银行卡图片文件,base64编码
version可选String解析服务版本:"v1"/"v2", 默认为v1,版本区别见接口返回部分

API返回(具体见通用返回字段及错误码

v1版本接口返回

data 字段说明

字段类型说明备注
card_numberstring银行卡号
card_cornerscorner_info卡号位置信息卡号在图片中的位置

corner_info 字段说明

字段类型说明备注
left_topArray of Int左上坐标
right_topArray of Int右上坐标
right_bottomArray of Int右下坐标
left_bottomArray of Int左下坐标

v2版本接口返回

data 字段说明

字段类型说明备注
expired_dateString过期时间
expired_date_cornersCorner过期时间在图片中的4个顶点坐标字段说明见下方
numberString卡号
number_cornersCorner卡号在图片中的4个顶点坐标字段说明见下方
bank_idString银行编号识别失败返回空字符串
bank_nameString银行名称识别失败返回空字符串
card_nameString卡类型识别失败返回空字符串

Corner 字段说明

字段类型说明备注
left_toplist顶点坐标[x, y]
right_toplist顶点坐标[x, y]
right_bottomlist顶点坐标[x, y]
left_bottomlist顶点坐标[x, y]

错误码(通用错误码见通用返回字段及错误码

HttpCode错误码错误消息描述
20010000请求成功
40060103"Missing Input Parameters: empty input image"输入图片为空
40061201"Invalid Input Parameters: get input image error"获取图片错误
40061202"Bank Card OCR Error"银行卡OCR识别错误
40061203"Invalid Input Parameters: No bank card detected in input image"未检测到银行卡

返回值示例

返回值示例

{
    "code":10000,
    "data":{
        "card_number": "5309 9999 0000 8000"
        "card_corners":{
            "left_top": 520,
            "right_top":71,
            "right_bottom":706,
            "left_bottom":283m
        },
    },
    "message":"Success",
    "request_id":"6838889517957515275",
    "time_elapsed":"41.897331ms"
}