接口描述

针对图片中的身份证，进行OCR检测，返回检测到的姓名、身份证号码等信息。

支持识别一张图片中有一个身份证正面或者反面的图像，也支持识别一张图片中有一正一反身份证图像。

当图片中包含两个正面、两个反面、三个（含）以上身份证图像时，会选择像素面积最大的一个身份证图像返回识别结果。

请求方法

POST

接口要求

• 图片格式限制：目前仅支持 jpg、jpeg、png、bmp 等常见格式

• 图片大小限制：图片单张大小不超过 10MB，批量请求单次不超过 5张

• 图片尺寸限制：图片像素尺寸应大于 32x32，小于 5000x5000

URI

/v1/aiop/api/2f3os7qq79xc/IdentityCard/ocr/v1/idcard.json

请求参数

1.请求头header参数

2.请求体body参数

请求代码示例

Curl -X POST
"https://${host}/${api}/v1/aiop/api/2f3os7qq79xc/IdentityCard/ocr/v1/idcard.json"
-H "Content-Type: application/json"
-H "Authorization: Bearer $API_KEY"
--data '{"data":["_9j_4AAQSkZJRg..."]}'

返回值说明

1.请求成功返回响应参数

表message

表returnObj

表detail

2.请求失败返回响应参数

表returnObj

返回值示例

1.请求成功返回值示例

{
    "statusCode": 0,
    "message": {"success" : 1, "fail" : 0},
    "returnObj": [{
        "note": "front",
        "detail": {
            "name": "",
            "sex": "",
            "nation": "",
            "birthday": "",
            "idn": "",
            "addr": "",
            "org": "兰州市公安局城关分局",
            "validperiod": "2007.07.27-2027.07.27"
        },
        "idcard_face": "no face",
        "demo_image": "demo_image",
        "risk": "normal"
    }]
}

2.请求失败返回值示例

示例1:
{
    "statusCode": 4004,
    "message": "error",
    "details": "data字段图片数据不是list格式",
    "error":"AI_OP_4004"
}
示例2:处理失败返回值示例
{
    'statusCode': 0,
    'message': {'success': 0, 'fail': 1},
    'returnObj': [{'err_code': 4008, 'err_msg': 'base64数据处理异常'}]
}

状态码

错误码说明

4 位错误码。4 开头为业务错误码，5 开头为服务错误码。

base64 编码规则：使用常规的 safe base64 编码方式

• python 中推荐使用 base64.urlsafe_b64encode() 函数进行编码

• java 中推荐使用 BASE64.getUrlEncoder().encodeToString() 函数进行编码