# 银行卡识别 API 文档

# 接口说明

银行卡识别，通过 OCR（光学字符识别 Optical Character Recognition）技术，自动对银行卡进行识别，返回银行卡原件上的银行卡卡号、有效日期、发卡行、卡片类型（借记卡&信用卡）、持卡人姓名（限信用卡）等信息，可以省去用户手动录入的过程，自动完成银行卡信息的结构化和图像数据的采集，可以很方便对接客户的后台数据系统，给用户带来极大的便利。采特有的图像处理技术，在识别银行卡图片过程中，还可以对银行卡图片上的卡号图像，方便用户保存。

该能力是通过HTTP API的方式给开发者提供一个通用的接口，适用于一次性交互数据传输的AI服务场景，块式传输。相较于SDK，API具有轻量、跨语言的特点，不过请注意该接口使用的HTTP API协议不支持跨域。

# 接口Demo

示例demo请点击 这里 下载。
目前仅提供部分开发语言的demo，其他语言请参照下方接口文档进行开发。
也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。

# 接口要求

集成银行卡识别API时，需按照以下要求。

# 接口调用流程

注： 若需配置IP白名单，请前往控制台。IP白名单规则请参照 IP白名单。

1. 通过接口密钥基于MD5计算签名，将签名以及其他参数放在Http Request Header中，详见下方 请求头 。
2. 将图片数据放在Http Request Body中，以POST表单的形式提交，详见下方 请求体 。
3. 向服务器端发送Http请求后，接收服务器端的返回结果，返回结果详见各接口的详细说明。

接口地址示例：

	POST http[s]://webapi.xfyun.cn/v1/service/v1/ocr/bankcard HTTP/1.1
	Content-Type:application/x-www-form-urlencoded; charset=utf-8

# 白名单

在调用该业务接口时

• 若关闭IP白名单，接口认为IP不限，不会校验IP。
• 若打开IP白名单，则服务端会检查调用方IP是否在讯飞开放平台配置的IP白名单中，对于没有配置到白名单中的IP发来的请求，服务端会拒绝服务。

IP白名单规则

• IP白名单，在 控制台-我的应用-相应服务的应用管理卡片上 编辑，保存后五分钟左右生效；
• 不同Appid的不同服务都需要分别设置IP白名单；
• IP白名单需设置为外网IP，请勿设置局域网IP；
• 如果服务器返回结果如下所示(illegal client_ip)，则表示由于未配置IP白名单或配置有误，服务端拒绝服务。

{
    "code":"10105",
    "desc":"illegal access|illegal client_ip",
    "data":"",
    "sid":"xxxxxx"
}

# 接口请求参数

# 请求头

在 Http Request Header 中配置以下参数。

# 授权认证

以下参数用于授权认证：

注：

• APIKey：接口密钥，在讯飞开放平台控制台添加相应服务后即可获取，调用方注意保管，如泄露，可到控制台提交工单联系技术人员重置；
  
• X-CheckSum 有效期：出于安全性考虑，每个 X-CheckSum 的有效期为 5 分钟(用 X-CurTime 计算)，同时 X-CurTime 要与标准时间同步，否则时间相差太大，服务端会直接认为 X-CurTime 无效；
  
• BASE64 编码采用 MIME 格式，字符包括大小写字母各26个，加上10个数字，和加号 + ，斜杠 / ，一共64个字符。
  

*X-CheckSum *生成示例：

String APIKey="abcd1234"; 
String X-CurTime="1502607694";
String X-Param="eyAiYXVmIjogImF1ZGlvL0wxNjtyYXR...";
String X-CheckSum=MD5(apiKey + X-CurTime + X-Param);

# 业务参数

X-Param 为各配置参数组成的 JSON 串经 BASE64 编码之后的字符串，原始 JSON 串各字段说明如下：

X-Param生成示例：

	原始JSON串：
	{
	    "engine_type": "bankcard",
	    "card_number_image": "0"
	}
	BASE64编码（即X-Param）：
	eyJlbmdpbmVfdHlwZSI6ICJiYW5rY2FyZCIsImNhcmRfbnVtYmVyX2ltYWdlIjogIjAifQ==

# 请求体

以POST表单的形式提交以下参数：

注：

1. 一般基础类库会默认进行urlencode处理，请注意不要重复处理
   
2. base64编码后大小会增加约1/3

# 接口返回参数

返回值为json串，各字段如下：

其中sid字段主要用于追查问题，如果出现问题，可以提供sid给讯飞技术人员帮助确认问题。

data各字段说明如下：

其中的error_msg和error_code的取值范围及说明对照表：

结果示例如下：

失败结果：

    {
        "code": "10106",
        "desc": "invalid parameter|invalid X-Appid",
        "data": "",
        "sid": "wcr0000bb3f@ch3d5c059d83b3477200"
    }

成功结果：

	{
	"code": "0",
	"data": {
		"card_number": "6258 0001 0097 9974",
		"error_code": 0,
		"error_msg": "ok",
		"holder_name": "LI YUAN",
		"issuer": "招商银行信用卡中心",
		"issuer_id": "03080010",
		"type": "贷记卡",
		"validate": "04/22"
	},
	"desc": "success",
	"sid": "wcr00000003@dx11730e797b8a000100"
	}

# 调用示例

银行卡识别demo go语言

银行卡识别demo php语言

银行卡识别demo java语言

银行卡识别demo python3语言

银行卡识别demo c#语言

银行卡识别demo nodejs语言

# 常见问题

# 银行卡识别的主要功能是什么？

答：基于行业领先的光学字符识别技术，将图片上的文字内容直接转化为可编辑文本。实现高精准，毫秒级识别体验。

# 银行卡识别的识别率是多少？

答：目前银行卡识别准确率高达99.6%。

# 上传图片格式和属性有什么要求吗？

答：图片格式jpg、jpeg;图片属性要求推荐设置为：尺寸1024×768，图像质量75以上，位深度24。 建议最短边最小不低于160 像素，最大不超过4000 像素。

# 银行卡识别支持哪些种类的银行卡？

答：支持14、15、16位卡号，凸面卡平面卡，以及VISA、JCB、银卡、Master卡、美国运通卡等。

# 银行卡识别的收费价格是多少？怎么购买？

答：每个账号免费领取一次3000服务量有效期90天，套餐一:1w次服务量/240元/年，套餐二:10w次服务量/2000元/年，套餐三:100w次服务量/16000元/年，可在控制台对应服务--->实时用量--->购买服务量，套餐详细说明页。