API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心

数据结构

最近更新时间：2023-08-17 01:06:04

我的收藏

本页目录：

AntiFraudCryptoFilter

AntiFraudCryptoFilter – 业务入参

被如下接口引用：GetAntiFraud。

名称 类型 必选 描述
CryptoType String 否 约定用入参，默认不涉及默认BusinessSecurityData 与BusinessCrptoData 不传
CryptoContent String 否 约定用入参，默认不涉及

AntiFraudFilter

AntiFraudFilter – 业务入参

被如下接口引用：GetAntiFraud。

名称 类型 必选 描述
CustomerUin String 是 业务方账号 ID
CustomerAppid String 是 业务方APPID
IdNumber String 是 身份证号
注 1：下方 idCryptoType 为指定
加密方式
注 2：若 idNumber 加密则必传加
密方式
PhoneNumber String 是 手机号码（注：不需要带国家代码
例如：13430421011）
注 1：下方 phoneCryptoType 为
指定加密方式:
注 2：若 phoneNumber 加密则必
传加密方式
Scene String 否 业务场景 ID
CustomerSubUin String 否 默认不使用，业务方子
账号，若接口使用密钥对应是子账
号则必填
Authorization String 否 已获取约定标识则传 1；
用于基于特定需求而传的标识字段
注：有约定则是必传，若未传则查
询接口失败
Name String 否 姓名
注 ：不支持加密
BankCardNumber String 否 银行卡号
UserIp String 否 用户请求来源 IP
Imei String 否 国际移动设备识别码
Idfa String 否 ios 系统广告标示符
EmailAddress String 否 用户邮箱地址
Address String 否 用户住址
Mac String 否 MAC 地址
Imsi String 否 国际移动用户识别码
AccountType String 否 关联的腾讯帐号 QQ：1；
开放帐号微信： 2；
Uid String 否 可选的 QQ 或微信 openid
AppIdU String 否 qq 或微信分配给网站或应用的
appid，用来唯一标识网站或应用
WifiMac String 否 ＷＩＦＩＭＡＣ
WifiSSID String 否 WIFI 服务集标识
WifiBSSID String 否 WIFI-BSSID
ExtensionId String 否 拓展字段类型 ID
注：默认不填写，需要时天御侧将
提供
ExtensionIn String 否 拓展字段内容
注：默认不填，需要时天御侧将提
供
BusinessId String 否 业务 ID，默认不传
IdCryptoType String 否 身份证加密类型
0：不加密（默认值）
1：md5
2：sha256
3：SM3
注：若 idNumber 加密则必传加密
方式
PhoneCryptoType String 否 手机号加密类型
0：不加密（默认值）
1：md5,
2：sha256
3：SM3
注：若 phoneNumber 加密则必传
加密方式
NameCryptoType String 否 姓名加密类型：——注：已经不支持加
密，该字段存在是为了兼容可能历史客户
版本；
0：不加密（默认值）
1：md5
OldResponseType String 否 是否使用旧回包

AntiFraudRecord

反欺诈查询结果

被如下接口引用：GetAntiFraud。

名称 类型 描述
Code String 公共错误码
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
CodeDesc String 业务侧错误码。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
Message String 业务侧错误信息。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
Found String 表示该条记录能否查到：1 为能查到；-1 为查不到，此时 RiskScore 返回-1；
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
IdFound String 表示该条记录中的身份 ID 能否查到
1 为能查到
-1 为查不到
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
RiskScore String 当可查到时，返回 0~100 区间，值越高 欺诈可
能性越大。
当查不到时（即 found=-1），返回-1
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
RiskInfo Array of SimpleKindRiskDetail 扩展字段，对风险类型的说明。扩展字段并非必
然出现。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
OtherModelScores Array of OtherModelScoresDetail 默认出现，提供模型版本号说明及多模型返回需
要时用到；
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
PostTime String 表示请求时间，标准 sunix 时间戳，非必然出现
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
ExtensionOut String 拓展字段，非必然出现，和 ExtensionIn 对应；
注：非必然出现，需要返回时天御侧将说明；
注意：此字段可能返回 null，表示取不到有效值。
示例值：0

FinanceAntiFraudCryptoFilter

借贷反欺诈密文业务入参

被如下接口引用：DescribeAntiFraud。

名称 类型 必选 描述
CryptoType String 否 值1定义：AES加密方式[加密模式ECB；填充格式pkcs7padding；秘钥16字节即128位
示例值：1
CryptoContent String 否 业务字段BusinessSecurityData的json数据格式，采用CryptoType相应的加密方式计算后得到的bash64编码内容。比如对{"PhoneNumber":"13430420001","IdNumber":"420115199501010001","BankCardNumber":"6214000100010001"}包体做加密。
示例值：vSGAQNoVdqlz2BK8DHxMw7XDMo4hK0uYQ6TM9jLxirMgWTKL/ou49YjfijuC1x/f

FinanceAntiFraudFilter

借贷反欺诈原始业务入参

被如下接口引用：DescribeAntiFraud。

名称 类型 必选 描述
PhoneNumber String 否 电话号码(五选二)
示例值：13430420001
IdNumber String 否 身份证Id(五选二) 参数详细定义请加微信：TYXGJ-01
示例值：420115199501010001
BankCardNumber String 否 银行卡号(五选二)
示例值：6214000100010001
UserIp String 否 用户请求来源 IP(五选二)
示例值：113.1.1.1
Imei String 否 国际移动设备识别码(五选二)
示例值：359355041886388
Idfa String 否 ios 系统广告标示符(五选二)
示例值：9C287922-EE26-4501-94B5-DDE6F83E1475
Scene String 否 业务场景ID，需要找技术对接
示例值：1001
Name String 否 姓名
示例值：张三
EmailAddress String 否 用户邮箱地址
示例值：373909726%40qq.com
Address String 否 用户住址
示例值：373909726%40qq.com
Mac String 否 MAC 地址
示例值：00-01-6C-06-A6-29
Imsi String 否 国际移动用户识别码
示例值：xxxyyzz
AccountType String 否 1：关联的腾讯帐号QQ；2：开放帐号微信
示例值：1
Uid String 否 可选的 QQ 或微信 openid
示例值：00000000000000000000000033121475
AppIdU String 否 qq 或微信分配给网站或应用的 appid，用来唯一标识网站或应用
示例值：100273020
WifiMac String 否 WIFI MAC
示例值：00-01-6C-06-A6-28
WifiSSID String 否 WIFI 服务集标识
示例值：test_wifi
WifiBSSID String 否 WIFI-BSSID
示例值：00-04-C3-A1-2B-22
BusinessId String 否 业务 ID，在多个业务中使用此服务，通过此ID 区分统计数据
示例值：0
PhoneCryptoType String 否 手机号加密类型 0：不加密（默认值）；1：md5；2：sha256；3：SM3
示例值：0
IdCryptoType String 否 身份证Id加密类型 0：不加密（默认值）；1：md5；2：sha256；3：SM3
示例值：0
NameCryptoType String 否 姓名加密类型 0：不加密（默认值）；1：md5；2：sha256；3：SM3
示例值：0

FinanceAntiFraudRecord

借贷反欺查询返回结果出参

被如下接口引用：DescribeAntiFraud。

名称 类型 描述
Found String 表示该条记录能否查到：1为能查到，-1为查不到
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
IdFound String 表示该条Id能否查到：1为能查到，-1为查不到
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
RiskScore String 评分0~100;值越高 欺诈可能性越大
注意：此字段可能返回 null，表示取不到有效值。
示例值：53
RiskInfo Array of RiskDetailInfo 扩展字段，对风险类型的说明
注意：此字段可能返回 null，表示取不到有效值。
示例值：[[{"RiskCode":5,"RiskValue":2}]
OtherModelScores Array of FinanceOtherModelScores 多模型返回结果
注意：此字段可能返回 null，表示取不到有效值。
示例值：[{"ModelId":0,"ModelScore":"53"}]
Code String 业务侧错误码。成功时返回0，错误时返回非0值
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
Message String 业务侧错误信息。成功时返回Success，错误时返回具体业务错误原因。
注意：此字段可能返回 null，表示取不到有效值
注意：此字段可能返回 null，表示取不到有效值。
示例值：success

FinanceOtherModelScores

借贷反欺返回结果出参中的多模型返回结果

被如下接口引用：DescribeAntiFraud。

名称 类型 描述
ModelId String 模型ID序号
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
ModelScore String 模型ID序号对应的评分结果
注意：此字段可能返回 null，表示取不到有效值。
示例值：53

OtherModelScoresDetail

扩展字段，对多模型返回结果的说明，被如下接口引用：GetAntiFraud。

被如下接口引用：GetAntiFraud。

名称 类型 描述
ModelId String 模型版本号；默认顺序为 0、1、2、3、…其中：0=主模型，跟 RiskScore 保持一致；
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
ModelScore String 模型版本对应的评分结果；Found=1 时：模型版本对应的评分结果，0~100 分
区间；Found=-1（未查到）时：全部模型结果返回-1
注意：此字段可能返回 null，表示取不到有效值。
示例值：100

RiskDetail

扩展字段，对风险类型的说明

被如下接口引用：QueryAntiFraud。

名称 类型 描述
RiskCode Integer 风险码 参数详细定义请加微信：TYXGJ-01

RiskDetailInfo

金融借贷反欺诈 风险码输出类型

被如下接口引用：DescribeAntiFraud。

名称 类型 描述
RiskCode String 风险码
注意：此字段可能返回 null，表示取不到有效值。
示例值：“1101”
RiskValue String 风险码对应的风险值
注意：此字段可能返回 null，表示取不到有效值。
示例值：“123”

SimpleKindRiskDetail

扩展字段，对风险类型的说明

被如下接口引用：GetAntiFraud。

名称 类型 描述
RiskCode String 风险码
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
RiskCodeValue String 风险码详情
注意：此字段可能返回 null，表示取不到有效值。
示例值：""
中国站