本文介绍阿里云 ID Verification提供的服务端 API,可以通过调用这些 API 集成ID Verification 服务。
服务公网接入域名为 cloudauth-intl.[region].aliyuncs.com,各地域及单接口QPS如下:
地域 | 地域ID | 单接口QPS |
新加坡 | ap-southeast-1 | 10 |
中国香港 | cn-hongkong | 10 |
马来西亚(吉隆坡) | ap-southeast-3 | 3 |
印度尼西亚 | ap-southeast-5 | 3 |
QPS限制说明:
文档标注的QPS为阿里云主账户下单接口的QPS限制,同一账户下的多个RAM用户共享该限制。
如业务量超过标注的QPS,请联系产品及商务团队申请扩容。
不同地域的产品服务端接口QPS可能不同,以本文档标注为准。
受合规要求限制,马来西亚和印度尼西亚的产品能力采用本地部署方案,建议在接入前联系产品团队确认QPS。
实人认证
提供完整的数字在线解决方案,实现了身份验证过程中涉及的证件验证、活体验证和风险检测等多种能力。
支持以下三种集成模式:
App SDK 模式:用户在商户的移动 App 中启动身份验证流程。
Web SDK 模式:用户通过移动或 PC 端浏览器启动身份验证流程。
Webview嵌入App模式:用户在商户的移动 App 中,利用内嵌Webview通过移动浏览器启动身份验证流程。
App SDK 接入/Web SDK 接入/ Webview嵌入App接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
InitializeV2 | 每次发起 eKYC PRO 认证流程前调用,获取 对于Web SDK与Webview嵌入App接入方式,将额外返回 ProductCode: | ||
CheckResult | 收到回调通知后获取认证状态及材料,包括人脸验证结果、证件 OCR 结果、风险控制结果等,结果保留 30 天。 |
活体检测
提供纯人脸活体检测在线认证方案,通过活体检测验证用户身份真实性,不含证件验证能力。
支持以下四种集成模式:
App SDK 模式:用户在商户的移动 App 中完成活体检测。
Web SDK 模式:用户通过移动或 PC 端浏览器完成活体检测。
Webview嵌入APP模式:用户在商户的移动 App 中,利用内嵌Webview通过移动浏览器完成活体检测。
纯服务端(API)模式:商户直接传入已采集的人脸图片,服务端完成活体检测,无需集成客户端 SDK。
App SDK 接入/Web SDK 接入/ Webview嵌入App接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
InitializeV2 | 每次发起活体认证流程前调用,获取 对于Web SDK与Webview嵌入App接入方式,将额外返回 ProductCode: | ||
CheckResult | 收到回调通知后获取认证状态及材料,包括活体认证结果等,结果保留 30 天。 |
纯服务端(API)接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
FaceLivenessV2 | 直接传入人脸图片,基于 Qwen-VL 模型完成活体及 Deepfake 检测,无需 SDK 及交互式活体挑战。ProductCode: |
身份核验与防重
提供多种活体验证方案,包含人脸验证(1:1)和防重检测(1:N检索)模式,适用于防止重复注册、身份欺诈等业务场景。
支持以下四种集成模式:
App SDK 模式:用户在商户移动 App 内完成活体验证、人脸验证或防重检索流程。
Web SDK 模式:用户在移动端或 PC 端浏览器中完成活体验证、人脸验证或防重检索流程。
WebView 嵌入 App 模式:用户在商户移动 App 内,通过内嵌 WebView 调用移动端浏览器完成活体验证、人脸验证或防重检索流程。
纯服务端(API)模式:商户直接传入已采集的人脸图片,由服务端完成活体验证、人脸验证或防重检索流程,无需集成客户端 SDK。
App SDK 接入/Web SDK接入/ Webview嵌入App接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
InitializeV2 | 每次发起认证流程前调用,获取 Web SDK接入支持额外返回 ProductCode: | ||
CheckResult | 收到回调通知后获取认证状态及材料。返回结果包含活体认证结果、人脸比对评分(faceComparisonScore)、重复人脸检测结果(duplicateFace)以及注册人脸库 ID(faceRegistrationID)等字段。上述认证结果数据保留 30 天。 |
纯服务端(API)接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
FaceDuplicationCheckIntl | 直接传入人脸图片,无需 SDK,服务端完成人脸去重检测与比对,支持 1:1 核验、1:N 检索及合并模式。 ProductCode: |
人脸库管理
人脸库管理不是一个独立的产品,而是活体验证中1:N检测方案的管理功能,用于管理供 1:N 检索使用的人脸库数据。
接口名称 | 描述 | 文档链接 | openAPI门户 |
AddFaceRecord | 将用户人脸图片注册至指定人脸库,支持 Base64、URL、本地文件流三种传入方式,返回注册结果及人脸质量评估。 | ||
DeleteFaceRecordV2 | 通过用户唯一标识MerchantUserId(与 AddFaceRecord 入库时保持一致),删除人脸库中人脸照片,返回删除状态。 |
人脸比对
提供纯服务端人脸图片相似度比对能力,判断两张人脸图片是否为同一人。
支持以下集成模式:
纯服务端(API)模式:商户直接传入两张人脸图片,服务端完成比对返回结果和评分,无需集成客户端 SDK。
纯服务端(API)接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
FaceCompareV2 | 传入两张人脸图片(支持 Base64、URL、本地文件流三种传入方式),比对是否为同一人,返回比对结果(Passed)及相似度评分(0-100)。 |
证件OCR识别
提供基于 Qwen-VL 大模型的证件识别方案,支持全球多种身份证件类型的自动检测与信息识别,适用于远程身份认证和自动信息录入等场景。
支持以下四种集成模式:
App SDK 模式:用户在商户的移动 App 中完成活体验证。
Web SDK 模式:用户通过移动或 PC 端浏览器完成活体验证。
Webview嵌入App模式:用户在商户的移动 App 中,利用内嵌Webview通过移动浏览器完成活体验证。
纯服务端(API)模式:商户直接传入已采集的证件图片,服务端完成OCR识别,无需集成客户端 SDK。
App SDK 接入/Web SDK 接入/ Webview嵌入App接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
InitializeV2 | 每次发起证件OCR 认证流程前调用,获取 ProductCode: | ||
CheckResult | 收到回调通知后,向服务端获取基于 Qwen-VL 模型自动识别证件类型并提取结构化信息,支持正反面识别及防伪检测。 |
纯服务端(API)接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
DocOcrMaxV2 | 传入证件图片,基于 Qwen-VL 模型自动识别证件类型并提取结构化信息,支持正反面识别及防伪检测。 ProductCode: |
证件NFC识别
提供基于手机 NFC 功能进行证件芯片解码的识别方案,读取证件芯片加密信息,可有效防止黑产合成证件图片攻击,提升业务安全风控能力。当前支持全球护照。
支持以下集成模式:
App SDK 模式:用户在商户的移动 App 中完成证件NFC识别。
App SDK 接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
InitializeV2 | 客户端获取 MetaInfo 后调用,获取 ProductCode: | ||
CheckResult | 获取 NFC 读取结果,返回护照完整结构化信息(姓名、证件号、国籍、有效期等)及人脸照片(Base64),结果保留 30 天。 |
设备助手
设备风险识别是一个独立的产品方案,也作为辅助风控功能,通过客户端 SDK 采集设备 Token,服务端查询设备风险评估结果,识别 ROOT/越狱、VPN、模拟器、虚拟环境及行为异常等风险。
支持以下两种集成模式:
App SDK 模式:用户无业务流程。
Web SDK 模式:用户无业务流程。
App SDK接入/Web SDK 接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
FaceGuardRisk | 传入客户端 SDK 生成的 ProductCode: |
凭证篡改检测
提供判断图片是否经过 PS、截屏、翻拍或篡改的风险检测服务。
支持以下集成模式:
纯服务端(API)模式:商户直接传入凭证图片,服务端完成风险判断,无需集成客户端 SDK。
纯服务端(API)接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
CredentialVerifyIntl | 传入凭证图片信息,返回是否伪造、篡改,截屏,翻拍等风险。 ProductCode: |
凭证识别
基于 Qwen-VL 模型,对用户上传的凭证文件进行关键信息识别与结构化提取,输出可供下游系统直接消费的数据,并可选配伪造检测功能。
支持以下集成模式:
纯服务端(API)模式:商户直接传入凭证图片或者PDF格式,服务端完成关键信息识别和伪造风险判断,无需集成客户端 SDK。
纯服务端(API)接入-同步调用
接口名称 | 描述 | 文档链接 | openAPI门户 |
CredentialRecognitionIntlV2 | 传入凭证图片或者PDF格式,获取凭证关键信息识别和伪造风险判断。 ProductCode: |
纯服务端(API)接入-异步调用
接口名称 | 描述 | 文档链接 | openAPI门户 |
CredentialSubmitIntlV2 | 传入凭证图片或者PDF格式,提交凭证识别任务,获取 ProductCode: | ||
CredentialGetResultIntl | 通过 ProductCode: |
印尼权威源核验服务
该服务是一项独立的印度尼西亚身份信息真实性校验服务,同时作为 eKYC_PRO 身份验证方案的补充,用于权威源核验场景。服务通过将客户提供的身份证号、姓名、人脸图像及出生日期与官方数据库进行比对,验证信息的一致性,从而提升用户身份的可信度。
支持以下集成模式:
纯服务端(API)模式:商户直接传入身份信息和人脸图片,服务端完成核验比对,无需集成客户端 SDK。
纯服务端(API)接入
接口名称 | 描述 | 文档链接 | openAPI门户 |
IdnAuthorityVerifyIntl | 传入身份信息和人脸图片,服务端完成权威源核验比对,返回权威源比对结果。 ProductCode: |
认证日志查询
功能性接口,通过 TransactionId 自助查询全链路日志,可用于分析未完成认证的人脸识别过程及流失原因,此接口不涉及计费。仅可查询有客户端接入的方案日志,不支持纯服务端接入方案。
接口名称 | 描述 | 文档链接 | openAPI门户 |
CheckVerifyLog | 传入调用 Initialize接口获取的TransactionId,获取全链路日志记录。 |
删除认证记录
功能性接口,支持通过接口删除部分产品方案认证结果中敏感信息和数据。
接口名称 | 描述 | 文档链接 | openAPI门户 |
DeleteVerifyResult | 传入调用Initialize接口获取TransactionId ,和对应需要删除的数据范围和相关配置,进行对应认证记录删除。 |
客户端主动保持链接
功能性接口,服务器调用ID Verification API频率较低场景时用于保持与客户端的连接。
接口名称 | 描述 | 文档链接 | openAPI门户 |
KeepaliveIntl | 此接口没有输入参数,无具体业务逻辑,主要用于服务器调用IDV频率较低时,客户端主动调用此接口以保持连接。 |