ocrIdCard

解释:用户向服务请求识别身份证,身份证识别包括正面和背面。

方法参数:Object

Object 参数说明

参数名类型必填默认值说明
detect_directionBoolean-是否检测图像旋转,可检验图像的选装方向和旋转角度。
· true:检测旋转角度并矫正识别。针对摆放情况不可控制的情况建议本参数置为true;

· false:不检测旋转角度,默认不检测。
id_card_sideString-front:身份证含照片的一面;back:身份证带国徽的一面。
imageString-图片资源地址
detect_riskBoolean-是否开启身份证风险类型(身份证复印件、临时身份证、身份证翻拍、修改过的身份证)功能,默认不开启,即:false。可选值:true-开启;false-不开启。
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明:

参数类型说明
directionNumber图像方向,当 detect_direction=true 时存在。-1: 未定义,0: 正向,1: 逆时针90度,2: 逆时针180度,3: 逆时针270度。
image_statusStringnormal-识别正常;reversed_side-身份证正反面颠倒;non_idcard-上传的图片中不包含身份证;blurred-身份证模糊;other_type_card-其他类型证照;over_exposure-身份证关键字段反光或过曝;unknown-未知状态。
risk_typeString输入参数 detect_risk = true 时,则返回该字段识别身份证类型: normal-正常身份证;copy-复印件;temporary-临时身份证;screen-翻拍;unknown-其他未知情况。
edit_toolString如果参数 detect_risk = true 时,则返回此字段。如果检测身份证被编辑过,该字段指定编辑软件名称,如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值无此参数。
log_idString唯一的log id,用于问题定位。
words_result_numNumber识别结果数,表示words_result的元素个数。
words_resultObject定位和识别结果
+locationObject位置数组(坐标0点为左上角)
++leftNumber表示定位位置的长方形左上顶点的水平坐标。
++topNumber表示定位位置的长方形左上顶点的垂直坐标。
++widthNumber表示定位位置的长方形的宽度。
++heightNumber表示定位位置的长方形的高度。
++wordsString识别结果字符串

返回值示例:

  1. {
    "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
    }

示例代码:

  1. swan.chooseImage({
    success(res) {
    let image = res.tempFilePaths[0];
    swan.ai.ocrIdCard({
    image,
    success(res) {
    console.log(res.words_result);
    }
    });
    }
    });