纯服务端(API)接入(支持OCR)

本文介绍身份二要素核验(支持OCR)API接口。传入二代身份证图片(包括:国徽面和人像面),OCR提取姓名和身份证号,通过权威源核验其真实性及一致性。

接口信息

重要

在使用本接口前,请确保已完整阅读接入流程,并开通服务。

  • 接口名: Id2MetaVerifyWithOCR

  • 接口说明:传入二代身份证图片(包括:国徽面和人像面),OCR提取姓名和身份证号,通过权威源核验其真实性及一致性。

  • QPS限量:API独享QPS限量,详情请参见信息核验接口QPS限量说明

  • 服务地址(调用 API 时的 Endpoint):

    地域

    IPv4

    IPv6

    通用

    cloudauth.aliyuncs.com

    cloudauth-dualstack.aliyuncs.com

    北京

    cloudauth.cn-beijing.aliyuncs.com

    cloudauth-dualstack.cn-beijing.aliyuncs.com

    上海

    cloudauth.cn-shanghai.aliyuncs.com

    cloudauth-dualstack.cn-shanghai.aliyuncs.com

    说明
    • 服务地址可选择与业务服务器距离相近的 endpoint ,以降低延迟。

    • 也可以构建列表轮询使用,以提高可用性。

出入图片格式要求

  • 图片大小:图片大小不超过2 MB。图片过大可能会影响接口响应速度,甚至可能导致读取图片超时失败。

  • 图片格式:PNG、JPG、JPEG。

  • 图片分辨率:图片长宽需要大于64像素且小于8192像素。

  • 图片质量要求:图片模糊、内容遮挡、光线或图片角度异常都可能会对识别结果产生影响;在识别身份证人像面时,需要确保人脸呈现正向。

请求参数

名称

类型

是否必选

描述

示例值

CertUrl

String

重要

CertUrlCertFileObject二选一。

https://www.aliyun.com/cert.jpeg

身份证人像面图片。

公网可访问的HTTP、HTTPS链接。

CertFileObject

InputStream

身份证人像面图片输入流。

CertNationalUrl

String

重要

CertNationalUrlCertNationalFileObject二选一入参,也可以都不传递。

https://www.aliyun.com/cert.jpeg

身份证国徽面图片地址。国徽面

公网可访问的HTTP、HTTPS链接。

CertNationalFileObject

InputStream

身份证国徽面图片地址。

响应参数

名称

类型

描述

示例值

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF03****

Message

String

接口调用返回信息。

重要

此参数仅表示接口是否异常。

success

Code

String

返回码:200表示成功,其他均为失败。

重要
  • 此参数代表是否正确调用了接口,详细的返回码说明请参见服务端错误码

  • 业务核验结果请通过ResultObject中的字段查看。

200

ResultObject

BizCode

String

身份核验结果:

  • 1:校验⼀致

  • 2:校验不⼀致

1

CardInfo

String

{
  "address": "浙江省杭州市余杭区********",
  "birthDate": "19901226",
  "certName": "张*",
  "certNo": "1234561990122*****",
  "nationality": "汉",
  "authority": "xxx公安局",
  "startDate": "20201130",
  "endDate": "20301130"
}

OCR读取的身份证信息。可在ResultObject.CardInfo字段说明中查看详情。

ResultObject.CardInfo字段说明

名称

类型

示例值

描述

address

String

xxxxxxxx969

身份证上的住址。

birthDate

String

19901xxx

身份证上的出生日期。

certName

String

张三

身份证上的姓名。

certNo

String

1234561990122*****

身份证号。

nationality

String

民族。

authority

String

xxx公安局

签发机关。

startDate

String

20201130

有效期限开始时间。

endDate

String

20301130

有效期限结束时间。

SDK调用示例

重要

集成前请确保您已完整阅读接入流程开通了服务获取AccessKey且正确配置环境变量

关于SDK示例和安装包获取:

  • 您可以在OpenAPI的在线接口调试页面的右侧找到对应的SDK调用示例,并在代码示例的右上角点击SDK安装信息查看SDK的安装信息。

    说明

    注意选择所需的编程语言。

    image

  • 如果您有离线安装的需求,可以进入SDK安装页面选择需要语言SDK,并转到发布地址获取。

    image

  • OpenAPI平台可对接口进行在线调试,并获取SDK示例。

  • 代码示例工程各编程语言调用SDK的示例工程,可作为接入参考。