AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

金融级OCR服务端集成

更新时间：
复制为 MD 格式
产品详情
我的收藏

本文介绍服务端如何调用阿里云金融级 OCR 相关 API，包括发起认证请求（InitAuthVerify）和查询识别结果（DescribeAuthVerify）。适用于需在后端对接 OCR 能力并获取结构化证件信息的业务场景。

接口说明

全局接入地址：cloudauth.aliyuncs.com（IPv4）或cloudauth-dualstack.aliyuncs.com（IPv6）

请求方法：POST和GET

传输协议：HTTPS

QPS限量：API独享QPS限量，详情请参见服务端接口QPS限量说明。

InitAuthVerify-发起OCR请求

请求参数

名称

类型

是否必选

描述

示例

SceneId

Long

是

要接入的认证场景ID。该ID在控制台创建认证场景后自动生成。关于如何创建认证场景，请参见添加认证场景。

100000****

OuterOrderNo

String

是

您自定义的业务唯一标识，用于后续定位排查问题。

支持长度不超过32位的字母和数字的组合，请确保唯一。

e0c34a77f5ac40a5aa5e6ed20c35****

ProductCode

String

是

要接入的产品方案。取值：ID_OCR。

ID_OCR

MetaInfo

String

是

MetaInfo环境参数，需要通过客户端SDK获取。

{
  "zimVer": "3.0.0",
  "appVersion": "1",
  "bioMetaInfo": "4.1.0:1150****,0",
  "appName": "com.aliyun.antcloudauth",
  "deviceType": "ios",
  "osVersion": "iOS 10.3.2",
  "apdidToken": "",
  "deviceModel": "iPhone9,1"
}
说明

该示例仅供参考，实际集成中不能直接应用，具体参考SDK集成说明获取。

CardType

String

是

证件类型，取值：IDENTITY_CARD。

IDENTITY_CARD

IdSpoof

String

否

是否开启证件防伪检测功能：

  • Y：开启

  • N：关闭（默认）

Y

CallbackUrl

String

否

OCR结果的回调通知地址，回调请求方式默认为GET，回调地址必须以https开头，完成OCR识别后会回调该地址，并自动添加certifyId和subcode字段

警告

  • 该值在接口调用前将进行公网可访问性校验；若传入地址无法从公网访问，系统将返回400错误。

  • OCR 识别完成后将立即触发回调，但可能因网络等因素产生延迟。建议优先接收客户端侧的请求完成通知，再请求查询接口获取结果详情。

https://www.aliyun.com?callbackToken=100000****&certifyId=shaxxxx&subCode=200

CallbackToken

String

否

安全Token，由您自行生成，用于防重复、防篡改校验。

若设置了此值，将会在CallbackUrl回调时携带CallbackToken字段。

NMjvQanQgplBSaEI0sL86WnQplB

CardPageNumber

String

是

SDK采集卡证页数：

  • “1”：采集正面

  • “2”：采集正反两面

1

DocScanMode

String

否

OCR证件扫描模式：

  • shoot（默认）：拍照

  • scan：扫描

  • auto：拍照/扫描自动切换

shoot

返回数据

名称

类型

描述

示例值

RequestId

String

请求ID。

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

Code

String

返回码，Success 指接口响应成功。

您可以在返回Code中查看不同 Code 的详细描述。

Success

Message

String

请求信息的响应消息，对 Code（返回码）的简短描述。

success

Result

CertifyId

String

核验请求ID，核验服务认证请求的唯一标识。

查询认证结果时，必须传入认证请求ID。

91707dc296d469ad38e4c5ef********

返回Code

HTTP状态码

Code

Message描述

200

Success

请求成功。

400

MissingParameter

参数不能为空。

InvalidParameter

非法参数。

403

Forbidden.AccountAccessDenied

确保您开通了服务，并且保证账户未欠费。

500

InternalError

系统内部错误，请反馈工程师排查。

DescribeAuthVerify-获取OCR结果

请求参数

名称

类型

是否必选

描述

示例

SceneId

Long

是

认证场景ID。该ID在控制台添加认证场景后自动生成。

1000000006

CertifyId

String

是

实人认证唯一标识。

该值需要调用InitAuthVerify-发起OCR请求获取。

91707dc296d469ad38e4c5efa6a0****

返回数据

名称

类型

描述

示例值

RequestId

String

请求ID。

130A2C10-B9EE-4D84-88E3-5384FF039795

Code

String

返回码：200为成功，其他为失败。

您可以在返回Code中查看不同 Code 的详细描述。

200

Message

String

请求信息的响应消息，对 Code（返回码）的简短描述。

success

Result.SubCode

String

结果描述。

200

Result.MaterialInfo

String

  • OCR读取的卡证信息（ocrIdCardInfo）

  • 客户端编辑后的卡证信息照片（ocrIdEditInfo）

  • OCR照片的OSS存储位置及链接（ocrPictureInfo）

说明

  • 若客户端未配置编辑，则ocrIdEditInfo默认返回和ocrIdCardInfo保持一致。

  • OCR照片相关字段ocrPictureInfo 返回依赖控制台认证场景的配置：

    • 控制台开启“留存认证资料”选项。

    • 控制台已配置并启用OSS授权。

"ocrIdCardInfo": {
    "certName": "张先生",
    "sex": "男",
    "nationality": "汉",
    "birthDate": "20010213",
    "address": "XXX省XX市XXX区XX街道X号",
    "certNo": "4****************X",
    "authority": "XXX公安局XXX分局",
    "startDate": "20250523",
    "endDate": "20450523"
  },
"ocrIdEditInfo": {
    "certName": "张先生",
    "sex": "男",
    "nationality": "汉",
    "birthDate": "20010213",
    "address": "XXX省XX市XXX区XX街道X号",
    "certNo": "4****************X",
    "authority": "XXX公安局XXX分局",
    "startDate": "20250523",
    "endDate": "20450523"
  },
  "ocrPictureInfo": {
    "ossBucketName": "cn-shanghai-aliyun-cloudauth-12********",
    "ossIdFaceObjectName": "verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridface_b749.jpeg",
    "ossIdFaceUrl": "http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridface_b749.jpeg?security-token=CAISjdfgeJ1q6F...",
    "ossIdNationalEmblemObjectName": "verify/1234567890/f7ed1ef80ad1234fdsd95c********cd_ocridnationalemblem_a3hf.jpeg",
    "ossIdNationalEmblemUrl": "http://cn-shanghai-aliyun-cloudauth-1234567890.oss-cn-shanghai.aliyuncs.com/verify/1234567890/f7ed1ef80ad1234fdsd95c66d83340cd_ocridnationalemblem_a3hf.jpeg?security-token=CAISjgJ1q6..."
  }

Result.SpoofInfo

String

证件正面防伪检测结果，包括风险判定结果和风险类型：

说明

仅当Initialize接口中 IdSpoof = Y时，才会开启卡证正面防伪检测。否则 spoofRiskResult 默认返回N，spoofType 为空。

  • spoofRiskResult：

    • Y：存在风险

    • N：无风险

  • spoofType：

    • SCREEN_REMARK：翻拍

    • PHOTO_COPY：复印件

    • TAMPER：PS篡改

说明

算法预测结果，该字段可能无法返回，建议业务上避免设置必要依赖。

  • spoofRiskResult：Y

  • spoofType：SCREEN_REMARK

Result.spoofBackInfo

String

证件反面防伪检测结果，包括风险判定结果和风险类型：

说明

仅当Initialize接口中 IdSpoof = Y 且SDK采集卡证页数CardPageNumber=2时，才会开启卡证反面防伪检测。否则 spoofRiskResult 默认返回N，spoofType 为空。

  • spoofRiskResult：

    • Y：存在风险

    • N：无风险

  • spoofType：

    • SCREEN_REMARK：翻拍

    • PHOTO_COPY：复印件

    • TAMPER：PS篡改

说明

算法预测结果，该字段可能无法返回，建议业务上避免设置必要依赖。

  • spoofRiskResult：Y

  • spoofType：SCREEN_REMARK

SubCode

错误码

认证记录是否计费

描述和原因建议

200

是

识别正常，可通过DescribeCardOCR接口获取识别结果。

212

是

证件防伪检测存在风险。可能存在翻拍、篡改、复印等高风险操作。

返回Code

HTTP状态码

Code

Message描述

200

Success

请求成功。

400

MissingParameter

参数不能为空。

InvalidParameter

非法参数。

CertifyIdInvalid

认证id无效

403

Forbidden.AccountAccessDenied

确保您开通了服务，并且保证账户未欠费。

404

ProcessNotCompleted

错误的请求。认证过程尚未完成.

500

InternalError

系统内部错误，请反馈工程师排查。