全部产品
Search
文档中心

ID Verification:服务端API接口

更新时间:Sep 17, 2026

本文介绍FACE_GUARD_PRO的服务端构建方法。

接口说明

  • 接口名:FaceGuardRisk

  • 请求方法:POST和GET

  • 传输协议:HTTPS

  • 重要

    FACE_GUARD_PRO按照查询成功计量,建议您同一个 Device Token 查询成功后不要再重复查询,避免重复计量。

  • QPS限量:API独享QPS限量,详情请参见服务端API QPS限量说明。

  • 全局接入地址:

    说明
    • 内网指的是阿里云同地域产品之间的内部通信网络,如果您的业务服务器部署在阿里云的对应地域,可以通过内网域名访问 ID Verification 服务,以获得更安全、稳定的网络通信质量。

    • 设备助手为了满足不同地域数据收集合规要求,提供了不同的数据上报站点,不同的站点之间数据隔离。

      客户端通过设置CustomUrl和CustomHost指定不同的上报站点,服务端需要基于客户端上报的站点,访问指定域名进行查询才能获取详情信息。

    新加坡

    • 公网:cloudauth-intl.ap-southeast-1.aliyuncs.com

    • 内网:cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com

    印度尼西亚

    • 公网:cloudauth-intl.ap-southeast-5.aliyuncs.com

    • 内网:cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com

    中国香港

    • 公网:cloudauth-intl.cn-hongkong.aliyuncs.com

    • 内网:cloudauth-intl-vpc.cn-hongkong.aliyuncs.com

    美西(硅谷)

    • 公网:cloudauth-intl.us-west-1.aliyuncs.com

    • 内网:cloudauth-intl-vpc.us-west-1.aliyuncs.com

    德国(法兰克福)

    • 公网:cloudauth-intl.eu-central-1.aliyuncs.com

    • 内网:cloudauth-intl-vpc.eu-central-1.aliyuncs.com

    马来西亚(吉隆坡)

    • 公网:cloudauth-intl.ap-southeast-3.aliyuncs.com

    • 内网:cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com

在线调试和集成

说明

在调试和集成前,请确保您已完整阅读使用OpenAPI文档,充分了解API接口在OpenAPI平台的调用方式和SDK及其代码的获取方式。

您可以在OpenAPI Explorer中直接运行本接口进行调试,并生成本接口的SDK代码示例。

请求参数

参数

类型

是否必选

描述

示例值

ProductCode

String

是

产品code:FACE_GUARD_PRO(固定值)。

FACE_GUARD_PRO

MerchantBizId

String

是

您自定义的业务唯一标识,用于后续定位排查问题使用,支持长度为32位的字母和数字的组合,请确保唯一。

e0c34a77f5ac40a5aa5e6ed2********

DeviceToken

String

是

通过客户端SDK获取的deviceToken。

Tk9SSUQuMS*****************ZDNmNWY5NzQxOW1o

BizId

String

否

本次业务认证的唯一ID,主要配合FACE_GUARD_PRO用于查询时校验。

1000******0001

返回参数

名称

类型

描述

示例值

RequestId

String

请求ID。

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

Code

String

返回Code,具体信息请参见服务端返回HTTP状态码说明。

Success

Message

String

返回Code的详细描述。

success

Result.TransactionId

String

整个认证流程的唯一标识。

e0c34a77f5ac40a5aa5e6ed2********

Result.RiskTags

String

设备风险标签。多个设备风险标签以半角逗号,分隔。如需了解更多设备风险标签及其含义,请参见设备助手风险标签。

ROOT,VPN,HOOK

Result.RiskExtends

String

拓展信息。具体信息,请参见Result.RiskExtends。

{
  "code": "Success",
  "message":"success"
  "umid":"07d3295d3d597b425d102a7f********",
  "sip":"198.51.100.1",
  "durationMs" : 4968931
  "queryCount":1,
  "querySessionCount":1,
  "queryUmidCount":1
  "platform":"Android
}

Result.GuardRiskScore

Double

设备助手算法预测的设备风险可能性,分数越高代表设备风险越高。

分值取值:0~100。

99

Result.RiskExtends

字段

含义

详细说明

code

token状态code

  • 200:token正常情况

  • 401:token内数据异常

  • 404:token内数据格式异常

  • 407:token过期(7天内有效)

  • 408:token或上报数据篡改

  • 500:token未知异常

message

token错误信息

token相关错误信息,code非200时有值。

umid

设备唯一ID

07d3295d3d597b425d102a7f********

platform

设备所处的平台

  • Android

  • iOS

  • Harmony

  • Web

sip

客户端IP

198.51.100.1

durationMs

查询时和端上初始化之间的时间差,单位毫秒。

4968931

queryCount

该token来当日查询的次数

1

querySessionCount

该token所处会话当日来查询的次数

2

queryUmidCount

该设备当日来查询的次数

2