1 接口定义:

平台仅支持以POST提交数据,请求参数个数固定,如下表所述:

接口名称身份证OCR
接口描述对身份证上的文字进行结构化识别,支持身份证头像抠取、有效期核实、证件防伪性验证。
承载协议HTTPS
承载网络公网
请求方式POST
数据格式返回数据:json格式
请求ContentTypemultipart/form-data
接口URLhttps://api-s.21cn.com:9083/id/idCardOCR.action

【请求参数】

字段标识说明数据类型可空
appKey授权访问的appKeytextN
accessToken通过appKey和appSecret获取的accessToken, 参考获取accessTokentextN
requestId请求编号, 查询跟踪问题时使用textN
cardType身份证图片类型,0-正面,1-反面。国徽面是反面, 照片姓名信息面是正面textN
file身份证图片文件二进制流,最大是1M,建议大小是200K左右fileN
needFace为1且cardType为正面时表示需要返回身份证上的人脸头像,不填或其他值表示不需要进行抠图textY
riskDetect身份证风险检测,为1时开启,开启后会判断身份证是否为临时身份证、翻拍和进行身份证有效期检验textY

【响应参数】

字段标识说明数据类型字段含义可空
errorCode1:成功,其他:请求失败number结果码N
errorMsg
string结果描述N
result详见《result对象》object身份证信息Y

【result对象】

字段标识说明数据类型字段含义可空
name
string证件姓名N
sex
string性别N
nation
string民族N
birthDay
string出生日期N
address
string地址N
idNumber
string身份证号N
validDate反面信息string证件有效期N
authority反面信息string发证机关N
idcardId
string
N
faceImage
string返回人脸照片Y
faceMsg成功获取到照片时返回成功,其余返回失败原因string返回人脸照片的信息Y
risk当riskDetect=1时返回
15005 翻拍
15006 复印件
15007 临时身份证
15011 身份证有效期过期 当cardType为反面时返回
string
Y

【返回示例】

  {
            "errorCode": 1,
            "errorMsg": "成功",
            "result": {
                "name": "xxx",
                "idNumber": "xxx",
                "address": "xx省xx市xxxxxx",
                "birthDay": "20000101",
                "sex": "男",
                "nation": "汉",
                "risk": 15005
            }
          }