RecognizeIdentityCard用于获取身份证正面、反面文字信息。

图片限制

  • 请求格式:JPEG、JPG、PNG、BMP、GIF。
  • 图像大小:图像大小在3M以内。
  • 图像分辨率:不限制图片分辨率,但图片分辨率太高可能会导致API推理的时间超时,推理超时时间为5s。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String RecognizeIdentityCard

系统规定参数。取值:RecognizeIdentityCard。

ImageURL String https://viapi-demo.oss-cn-shanghai.aliyuncs.com/viapi-demo/images/DetectImageElements/detect-elements-src.png

图片url地址(http/https)。

Side String face

身份证正反面类型。

  • face:正面。
  • back:反面。

返回数据

名称 类型 示例值 描述
RequestId String D6C24839-91A7-41DA-B31F-98F08EF80CC0

当前请求的request id。

Data Struct

返回的数据内容。

FrontResult Struct

正面照结果。

Address String 浙江省杭州市余杭区文一西路969号

地址信息。

Name String 张三

姓名。

Nationality String

民族。

IDNumber String 1234567890

身份证号。

Gender String

性别。

BirthDate String 20000101

出生日期,格式:YYYYMMDD,例如19800101,即1980年01月01日。

CardAreas Array

身份证区域位置,四个顶点表示,顺序是逆时针(左上、左下、右下、右上)。

X Float 165

横坐标。

Y Float 657

纵坐标。

FaceRectVertices Array

人脸位置,四个顶点表示。

X Float 1024.6600341796875

横坐标。

Y Float 336.629638671875

纵坐标。

FaceRectangle Struct

人脸位置。

Angle Float -90

表示矩形顺时针旋转的度数,范围-180~180。

Center Struct

人脸矩形中心坐标。

X Float 952

横坐标。

Y Float 325.5

纵坐标。

Size Struct

人脸矩形长宽。

Height Float 181.99

高度。

Width Float 164.99

宽度。

BackResult Struct

反面照结果。

StartDate String 19700101

有效期起始时间,格式:YYYYMMDD,例如19800101,即1980年01月01日。

EndDate String 19800101

有效期结束时间,格式:YYYYMMDD,例如19800101,即1980年01月01日。

Issue String 杭州市公安局

签发机关。

示例

请求示例

https://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeIdentityCard&<公共请求参数>

正常返回示例

XML 格式

<RequestId>D6C24839-91A7-41DA-B31F-98F08EF80CC0</RequestId>
<Data>
    <BackResult>
        <StartDate>19700101</StartDate>
        <EndDate>19800101</EndDate>
        <Issue>杭州市公安局</Issue>
    </BackResult>
</Data>

JSON 格式

{
"RequestId": "D6C24839-91A7-41DA-B31F-98F08EF80CC0",
"Data": {
  "FrontResult": {
    "Address": "浙江省杭州市余杭区文一西路969号",
    "Name": "张三",
    "Nationality": "汉",
    "IDNumber": "1234567890",
    "Gender": "男",
    "BirthDate": "20000101",
    "FaceRectangle": {
      "Angle": -90,
      "Center": {
        "X": 952,
        "Y": 325.5
      },
      "Size": {
        "Height": 181.99,
        "Width": 164.99
      }
    },
    "CardAreas": [
      {
        "X": 165,
        "Y": 657
      },
      {
        "X": 534,
        "Y": 658
      },
      {
        "X": 535,
        "Y": 31
      },
      {
        "X": 165,
        "Y": 30
      }
    ],
    "FaceRectVertices": [
      {
        "X": 1024.6600341796875,
        "Y": 336.629638671875
      },
      {
        "X": 906.66107177734375,
        "Y": 336.14801025390625
      },
      {
        "x": 907.1590576171875,
        "Y": 214.1490478515625
      },
      {
        "x": 1025.157958984375,
        "Y": 214.63067626953125
      }
    ]
  }
}
}

错误码

具体请参见常见错误码