调用RecognizeIdentityCard进行身份证识别_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

身份证识别可以识别二代身份证关键字段内容，关键字段包括：姓名、性别、民族、身份证号、出生日期、地址信息、有效起始时间、签发机关，同时可输出身份证区域位置和人脸位置信息。

说明

您可以进入在线咨询获取在线人工帮助。
当前能力可在视觉智能开放平台有完整的免费产品体验，您可以单击立即试用对该能力进行更直观试用以及在线购买。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。
目前只支持识别国内居民身份证，不支持中国香港、中国澳门、中国台湾身份证识别。

应用场景

远程注册：识别用户提交的身份证内容，自动完成用户身份信息填充。

特色优势

识别完整：支持识别身份证内各项内容。

接入指引

1. 注册阿里云账号：打开阿里云官网，在阿里云官网右上角，单击立即注册，按照操作提示完成账号注册。

2. 开通能力：请确保您已开通文字识别服务，若未开通服务请立即开通。

3. 创建AccessKey：请确保您已创建AccessKey，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见RAM授权。

4. 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。

5. 开发接入步骤：

在SDK总览中选择您要接入使用的SDK语言。
在对应语言的SDK文档中找到AI类目为文字识别（ocr）的SDK包进行安装。
参考文档中提供的示例代码进行适当修改后调用。

6. 示例代码：该能力常用语言的示例代码，请参见身份证识别示例代码。

7. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。

输入限制

图像格式：JPEG、JPG、PNG、BMP、GIF。
图像大小：不超过3 MB。
图像分辨率：大于15×15像素，小于4096×4096像素。
URL地址中不能包含中文字符。

计费说明

关于身份证识别的计费方式及报价，请参见计费介绍。

说明下方调试接口为付费接口，如需免费体验调试请前往体验中心。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	RecognizeIdentityCard	系统规定参数。取值：RecognizeIdentityCard。
ImageURL	String	是	http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfz1.jpg	图像URL地址。推荐使用上海地域的OSS链接，对于文件在本地或者非上海地域OSS链接的情况，请参见文件URL处理。
Side	String	否	face	身份证正反面类型。 face：人像面。 back：国徽面。

返回数据

名称	类型	示例值	描述
RequestId	String	A6175A03-624C-1976-908D-C8BE4C547C45	请求ID。
Data	Object		返回的结果数据内容。
BackResult	Object		国徽面结果。
EndDate	String	19800101	有效期结束时间，格式：YYYYMMDD，例如19800101，即1980年01月01日。
Issue	String	杭州市公安局	签发机关。
StartDate	String	19970101	有效期起始时间，格式：YYYYMMDD，例如19800101，即1980年01月01日。
FrontResult	Object		人像面结果。
FaceRectangle	Object		人脸位置。
Size	Object		人脸矩形尺寸。
Width	Float	196	宽度。
Height	Float	243	高度。
Angle	Float	0	表示矩形顺时针旋转的度数，范围-180~180。
Center	Object		人脸矩形中心坐标。
Y	Float	225	人脸矩形中心纵坐标。
X	Float	667	人脸矩形中心横坐标。
BirthDate	String	19880722	出生日期，格式：YYYYMMDD，例如19800101，即1980年01月01日。
Gender	String	男	性别。
Address	String	江苏省南京市浦口区天天小区1栋11号	地址信息。
FaceRectVertices	Array of FaceRectVertice		人脸位置。通过四个顶点表示，顺序是逆时针，依次为：左下，右下，右上，左上。
Y	Float	105	人脸位置纵坐标。
X	Float	569	人脸位置横坐标。
CardAreas	Array of CardArea		身份证区域位置。通过四个顶点表示，顺序是逆时针，依次为：左上、左下、右下、右上。
Y	Float	485	身份证区域纵坐标。
X	Float	132	身份证区域横坐标。
Nationality	String	汉	民族。
Name	String	小明	姓名。
IDNumber	String	320001198807220000	身份证号。

SDK参考

阿里云视觉AI文字识别类目下的身份证识别能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为文字识别（ocr）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见SDK总览。

示例代码

该能力常用语言的示例代码，请参见身份证识别示例代码。

示例

请求示例

http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeIdentityCard      //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&ImageURL=http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/ocr/RecognizeIdentityCard/sfz1.jpg
&Side=face
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RecognizeIdentityCardResponse>
    <RequestId>A6175A03-624C-1976-908D-C8BE4C547C45</RequestId>
    <Data>
        <FrontResult>
            <Address>江苏省南京市浦口区天天小区1栋11号</Address>
            <FaceRectVertices>
                <X>569</X>
                <Y>105</Y>
            </FaceRectVertices>
            <FaceRectVertices>
                <X>766</X>
                <Y>104</Y>
            </FaceRectVertices>
            <FaceRectVertices>
                <X>766</X>
                <Y>348</Y>
            </FaceRectVertices>
            <FaceRectVertices>
                <X>569</X>
                <Y>348</Y>
            </FaceRectVertices>
            <FaceRectangle>
                <Center>
                    <X>667</X>
                    <Y>225</Y>
                </Center>
                <Angle>0</Angle>
                <Size>
                    <Height>243</Height>
                    <Width>196</Width>
                </Size>
            </FaceRectangle>
            <CardAreas>
                <X>132</X>
                <Y>485</Y>
            </CardAreas>
            <CardAreas>
                <X>132</X>
                <Y>47</Y>
            </CardAreas>
            <CardAreas>
                <X>817</X>
                <Y>47</Y>
            </CardAreas>
            <CardAreas>
                <X>818</X>
                <Y>482</Y>
            </CardAreas>
            <Gender>男</Gender>
            <Nationality>汉</Nationality>
            <BirthDate>19880722</BirthDate>
            <Name>小明</Name>
            <IDNumber>320001198807220000</IDNumber>
        </FrontResult>
    </Data>
</RecognizeIdentityCardResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "A6175A03-624C-1976-908D-C8BE4C547C45",
  "Data" : {
    "FrontResult" : {
      "Address" : "江苏省南京市浦口区天天小区1栋11号",
      "FaceRectVertices" : [ {
        "X" : 569,
        "Y" : 105
      }, {
        "X" : 766,
        "Y" : 104
      }, {
        "X" : 766,
        "Y" : 348
      }, {
        "X" : 569,
        "Y" : 348
      } ],
      "FaceRectangle" : {
        "Center" : {
          "X" : [ 667 ],
          "Y" : [ 225 ]
        },
        "Angle" : 0,
        "Size" : {
          "Height" : [ 243 ],
          "Width" : [ 196 ]
        }
      },
      "CardAreas" : [ {
        "X" : 132,
        "Y" : 485
      }, {
        "X" : 132,
        "Y" : 47
      }, {
        "X" : 817,
        "Y" : 47
      }, {
        "X" : 818,
        "Y" : 482
      } ],
      "Gender" : "男",
      "Nationality" : "汉",
      "BirthDate" : "19880722",
      "Name" : "小明",
      "IDNumber" : "320001198807220000"
    }
  }
}

错误码

关于身份证识别的错误码，详情请参见常见错误码。

安全声明

请确保上传的图片或文件来源符合相应的法律法规。
通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。