Skip to content

身份证识别V2


接口描述

身份证识别,通过光学字符识别技术,识别身份证正面的 6 个字段(姓名,性别,年龄,地址,身份证号),以及身份证反面的两个字段(签发机关,有效期).

请求说明

HTTP 方法:

POST

请求 URL V2(建议使用):

/ai-cloud-face/ocr/v2/idcard

Header如下:

参数名称
Content-Typeapplication/json;charset=UTF-8

Body中放置请求参数,参数详情如下:

请求参数:

参数名称必填数据类型长度参数描述
imgString1-3000k待处理图片(base64 编码),原始图片大小需要小于 3M;
getFaceString0-11:返回截取的人脸图片,0:不返回人脸图片(默认);正面身份证才返回结果
getIdCardImgString0-1是否需要返回对齐后身份证图片(非必填) 1:需要返回对齐后的身份证图片 空或非1:不需要返回对齐后的身份证图片
busFlowIdString0-64业务流水号,业务系统唯一序列号(对账用,建议传入)

请求示例:

{
    "img":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQ......",
    "busFlowId":"uRVJfd594lRwz7m3"
}

返回说明

返回参数:

返回值名称数据类型长度描述
codeString1-8返回结果,00000000表示成功
messageString1-255返回码描述
dataObject-返回的数据
-flowIdString1-64交易流水ID(建议保存)
-typeint11表示正面,0表示反面
-addressString1-255地址
-nameString1-32姓名
-folkString1-4民族
-cardnoString1-32身份证号码
-birthdayString1-16出生日期
-sexString1-4性别
-idCardImgString1-200k返回的对齐后的身份证图片(getIdCardImg为1的情况下才返回)
-validdate1String1-16有效期开始日期,如20120222
-validdate2String1-16有效期结束日期,如20220221
-authorityString1-32签发机关
-faceObject-返回的人脸信息(getFace为1的情况下才返回)
--leftint4人脸在身份证中 x 坐标
--topint4人脸在身份证中y 坐标
--widthint4人脸宽度
--heightint4人脸高度
--imageString1-200k人脸图片(base64 编码)
-busFlowIdString1-64传入的业务流水号

返回示例:

{
    "code": 0,
    "data": {
        "busFlowId":"uRVJfd594lRwz7m3",
        "flowId": "1008375977018925056",
        "birthday": "1994年09月15日",
        "address": "xx省xx县xx镇xx村49号",
        "city": "xx县",
        "sex": "女",
        "idCardImg": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBA......",
        "type": "1",
        "cardno": "44082519940xxxxxx8",
        "face": {
            "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBA......"
            "top": 91,
            "left": 238,
            "width": 54,
            "height": 54
        },
        "province": "广东省",
        "name": "潘盼",
        "folk": "汉"   
    },
    "success": true,
    "message": "success"
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共CODE码表

码值是否成功是否计费描述
00000000成功
50028100图片不能为空
50028103图片大小不能超过3M
50028272身份证识别异常
50028204引擎检测异常
80003002识别异常