百度智能小程序 用户向服务请求识别身份证
swan.ai.ocrIdCard
解释：用户向服务请求识别身份证，身份证识别包括正面和背面。
方法参数
Object object
object 参数说明
| 属性名 | 类型 | 必填 | 默认值 | 说明 | |||
|---|---|---|---|---|---|---|---|
|
detect_direction |
Boolean |
否 |
是否检测图像旋转，可检验图像的旋转方向和旋转角度。
|
||||
|
id_card_side |
String |
否 |
- |
front：身份证含照片的一面；back：身份证带国徽的一面。 |
|||
|
image |
String |
是 |
图片资源地址 |
||||
|
detect_risk |
Boolean |
否 |
- |
是否开启身份证风险类型(身份证复印件、临时身份证、身份证翻拍、修改过的身份证)功能，默认不开启，即：false 。有效值：true-开启；false-不开启。 |
|||
|
success |
Function |
否 |
接口调用成功的回调函数 |
||||
|
fail |
Function |
否 |
接口调用失败的回调函数 |
||||
|
complete |
Function |
否 |
接口调用结束的回调函数（调用成功、失败都会执行） |
||||
success 返回参数说明
| 参数 | 类型 | 说明 | |||
|---|---|---|---|---|---|
|
direction |
Number |
图像方向，当 detect_direction=true 时存在。-1：未定义，0：正向，1：逆时针 90 度，2：逆时针 180 度，3：逆时针 270 度。 |
|||
|
image_status |
String |
normal-识别正常；reversed_side-身份证正反面颠倒；non_idcard-上传的图片中不包含身份证；blurred-身份证模糊；other_type_card-其他类型证照；over_exposure-身份证关键字段反光或过曝；unknown-未知状态。 |
|||
|
risk_type |
String |
输入参数 detect_risk = true 时，则返回该字段识别身份证类型：normal-正常身份证；copy-复印件；temporary-临时身份证；screen-翻拍；unknown-其他未知情况。 |
|||
|
edit_tool |
String |
如果参数 detect_risk = true 时，则返回此字段。如果检测身份证被编辑过，该字段指定编辑软件名称，如：Adobe Photoshop CC 2014 (Macintosh)，如果没有被编辑过则返回值无此参数。 |
|||
|
log_id |
Number |
唯一的 log id ，用于问题定位。 |
|||
|
words_result_num |
Number |
识别结果数，表示 words_result 的元素个数。 |
|||
|
words_result |
Object |
定位和识别结果 |
|||
words_result 返回值说明
| 参数名 | 参数类型 | 说明 |
|---|---|---|
|
住址 |
Object |
住址 |
|
公民身份号码 |
Object |
公民身份号码 |
|
出生 |
Object |
出生 |
|
姓名 |
Object |
姓名 |
|
性别 |
Object |
性别 |
|
民族 |
Object |
民族 |
住址/公民身份号码/出生/姓名/性别/民族 返回值说明
| 参数名 | 参数类型 | 说明 | |
|---|---|---|---|
|
location |
Object |
位置信息（坐标 0 点为左上角） |
|
|
words |
String |
识别结果字符串 |
|
location 返回值说明
| 参数名 | 参数类型 | 说明 | ||
|---|---|---|---|---|
|
left |
Number |
表示识别结果的定位位置的长方形左上顶点的水平坐标。 |
||
|
top |
Number |
表示识别结果的定位位置的长方形左上顶点的垂直坐标。 |
||
|
width |
Number |
表示识别结果的定位位置的长方形的宽度。 |
||
|
height |
Number |
表示识别结果的定位位置的长方形的高度。 |
||
示例
图片示例
代码示例
Page({
ocrIdCard() {
swan.chooseImage({
success: res => {
let image = res.tempFilePaths[0];
// AI系列的api有宿主使用限制,只可在百度App中使用,建议使用时加一层判断防止代码报未知错误
let host = swan.getSystemInfoSync().host;
if (host === 'baiduboxapp') {
swan.ai.ocrIdCard({
detect_direction: true,
id_card_side: 'front',
image, // 暂不支持识别网络图片
detect_risk: true,
success: res => {
console.log('ocrIdCard res', res.words_result);
},
fail: err => {
console.log('ocrIdCard err', err);
}
});
}
else {
swan.showToast({
title: '此api目前仅可在百度App上使用',
icon: 'none'
});
}
}
})
}
});
返回值示例
{
"log_id": $log_id,
"direction": 0,
"image_status": "normal",
"idcard_type": "normal",
"edit_tool": "Adobe Photoshop CS3 Windows",
"words_result": {
"住址": {
"location": {
"left": 267,
"top": 453,
"width": 459,
"height": 99
},
"words": "南京市江宁区弘景大道3889号"
},
"公民身份号码": {
"location": {
"left": 443,
"top": 681,
"width": 589,
"height": 45
},
"words": "330881199904173914"
},
"出生": {
"location": {
"left": 270,
"top": 355,
"width": 357,
"height": 45
},
"words": "19990417"
},
"姓名": {
"location": {
"left": 267,
"top": 176,
"width": 152,
"height": 50
},
"words": "伍云龙"
},
"性别": {
"location": {
"left": 269,
"top": 262,
"width": 33,
"height": 52
},
"words": "男"
},
"民族": {
"location": {
"left": 492,
"top": 279,
"width": 30,
"height": 37
},
"words": "汉"
}
},
"words_result_num": 6
}