文档中心 > 身份证识别

身份证识别

最近更新时间：2021-10-14

1 功能描述

身份证识别用于识别您上传的身份证图片中的文字内容，并将识别的结果返回给您。支持对二代居民身份证正反面所有8个字段进行结构化识别，包括姓名、性别、民族、出生日期、住址、身份证号、签发机关、有效期限。

2 请求说明

2.1 请求方式

调用地址：https://apim.unicloud.com/api/ocr/idcard/1.0.0/

请求方式：POST

返回类型：JSON

2.2 请求参数

Header如下：

参数	值	说明
Content-Type	application/json	--
Authorization	Bearer <Token>	参考Token获取

Body如下：

参数	是否必选	类型	可选值范围	说明
idcard_pic	与idcard_url二选一	file	--	身份证正面或反面图片（支持jpg、jpeg、png格式）
idcard_url	与idcard_pic二选一	string	--	身份证正面或反面URL路径
idcard_side	false	string	front/back	front：身份证人像面；back：身份证国徽面，默认为身份证人像面

注：Body使用form-data形式。

2.3 请求示例

curl -k  -H "Authorization:Bearer 2b8296e1-86a5-3a68-bd61-9b88f9dce5c0" -F "idcard_pic=@imgpath.jpg" https://apim.unicloud.com/api/ocr/idcard/1.0.0/

3 返回说明

3.1 返回参数

字段	类型	说明
sex	string	性别
name	string	姓名
ID_num	string	身份证号
birth	string	出生日期
address	string	住址
nation	string	民族
period_of_validity	string	有效期限
department	string	签发机关
code	string	是否正常返回（“succeed”,”failed”）

3.2 返回示例

身份证正面：

{    "Data": {        "name": "张三",        "ID_num": "511XXXXXXXXXXXXXXX",        "nation": "汉",        "address": "XX省XX市XX区XX街道XX号",        "birth": "1986年8月13日",        "sex": "男"
    },    "code": "succeed"}

身份证反面：

{    "Data": {        "period_of_validity": "2012.06.11-2022.06.11",        "department": "北京市公安局海淀分局"
    },    "code": "succeed"}