接入文档

身份证识别 API

最近更新时间:2020-10-22 17:48:19

注意:

如果因自身业务需要对 OCR 识别的影像文件进行存储或其他用途,请合作方务必自行保存订单号,通过订单号拉取 OCR 识别的影像文件是唯一方式。

合作方后台服务上送 sign、请求参数到身份证识别后台服务。

  • 请求 URL:https://ida.webank.com/api/paas/idcardocrapp
  • 请求方法:POST
  • 报文格式:Content-Type: application/json
  • 请求参数:
参数 说明 类型 长度(字节) 是否必填
webankAppId WebankAppId,由腾讯指定 String 腾讯云线下对接决定
version 接口版本号
默认值:1.0.0
String 20
nonce 随机数
32 位随机串(字母 + 数字组成的随机数)
String 32
sign 签名:使用 生成的签名 String 40
orderNo 订单号,由合作方上送,每次调用唯一 String 32
userId 用户的唯一标识(不要带有特殊字符) String 32
cardType 身份证正反面标识
0:人像面
1:国徽面
String 1
idcardStr 身份证人像面或者国徽面图片的 Base64,大小不超过3MB String 3145728
  • 响应参数:
参数 类型 说明
code String 身份证 OCR 识别结果的返回码
0:识别成功
其他:识别失败
warning String Code=0 是有值,姓名和身份证外的非关键信息有误会提示,合作方可以根据 warning 来确定
msg String 请求结果描述
ocrId String 保留字段,内部标识
orderNo String 订单号,由合作方上送,每次调用唯一,此信息为本次身份证 OCR 识别上送的信息
name String 身份证识别结果:姓名
sex String 身份证识别结果:性别
nation String 身份证识别结果:民族
birth String 身份证识别结果:出生日期
idcard String 身份证识别结果:身份证号
address String 身份证识别结果:地址
如果用户没有正确上传人像面,则没有该字段
authority String 身份证识别结果:签发机关
如果用户没有正确上传国徽面,则没有该字段
validDate String 身份证识别结果:有效日期
如果用户没有正确上传国徽面,则没有该字段
multiWarning String 正面多重告警码,详情请参见 身份证 OCR 错误码
clarity String 图片清晰度

响应示例:

{
    "code": "0",
    "msg": "请求成功",
    "bizSeqNo": "19112020001015300a17301200020263",
    "result": {
        "bizSeqNo": "19112020001015300a17301200020263",
        "transactionTime": "20191120173015",
        "ocrId": "15ad08ddd9c55157ffd1040a18412266",
        "orderNo": "order19959248596551",
        "name": "***",
        "sex": "男",
        "nation": "汉",
        "birth": "19880731",
        "address": "*****",
        "idcard": "***",
        "warning": "00000000",
        "sign": "5060AD347D015D8FD7DAC034977B28137204E8E6",
        "clarity": "78",
        "multiWarning": "00000000",
        "retry": "1",
        "success": false
    },
    "transactionTime": "20191120173015"
}
说明:

success:false 无意义,合作伙伴可忽略,无需处理。

计费

腾讯云文字识别 OCR 提供预付费和后付费两种计费模式,开通服务后默认使用后付费的计费模式。如果您拥有免费资源包或者付费资源包,将优先对资源包进行扣减,资源包耗尽后自动转入后付费(月结)的方式。详细的产品价格及计费方式请参考 OCR 计费说明

目录