1 接口定义:
平台仅支持以POST提交数据,请求参数个数固定,如下表所述:
接口名称 | 身份证OCR |
---|---|
接口描述 | 对身份证上的文字进行结构化识别,支持身份证头像抠取、有效期核实、证件防伪性验证。 |
承载协议 | HTTPS |
承载网络 | 公网 |
请求方式 | POST |
数据格式 | 返回数据:json格式 |
请求ContentType | multipart/form-data |
接口URL | https://api-s.21cn.com:9083/id/idCardOCR.action |
【请求参数】
字段标识 | 说明 | 数据类型 | 可空 |
---|---|---|---|
appKey | 授权访问的appKey | text | N |
accessToken | 通过appKey和appSecret获取的accessToken, 参考获取accessToken | text | N |
requestId | 请求编号, 查询跟踪问题时使用 | text | N |
cardType | 身份证图片类型,0-正面,1-反面。国徽面是反面, 照片姓名信息面是正面 | text | N |
file | 身份证图片文件二进制流,最大是1M,建议大小是200K左右 | file | N |
needFace | 为1且cardType为正面时表示需要返回身份证上的人脸头像,不填或其他值表示不需要进行抠图 | text | Y |
riskDetect | 身份证风险检测,为1时开启,开启后会判断身份证是否为临时身份证、翻拍和进行身份证有效期检验 | text | Y |
【响应参数】
字段标识 | 说明 | 数据类型 | 字段含义 | 可空 |
---|---|---|---|---|
errorCode | 1:成功,其他:请求失败 | 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 } }