风控知识库接口文档
更新时间:2025-09-18
一、接口简介
本接口用于查询IP和号码知识库,包括IP和号码的风险等级、风险得分、风险详情等。
二、接口协议和鉴权
2.1 接口协议
接口遵守restful风格,基于HTTP协议,UTF-8编码
请求和响应数据格式:JSON
接口 | URI | METHOD | 描述 |
---|---|---|---|
风控知识库查询 | rcs/knowledge | POST | 根据特征值查询风险和标签 |
2.2 接口地址
https://afd.bj.baidubce.com/rcs/knowledge
2.3 接口鉴权
接口鉴权按照百度云方式鉴权,可以使用以下sdk,补充百度云ak/sk,即可使用
sdk使用demo(点击下载): com.baidubce.services.risk.RiskClientDome
三、请求与返回
3.1 知识库查询
接口遵守restful风格,基于HTTP协议,UTF-8编码
3.1.1 请求体
编码 | 类型 | 含义 | 是否必填 | 备注 |
---|---|---|---|---|
ip | String | ip | 否 | 1.2.3.4 |
ipQueryStyle | String | ip查询类型 | 否 | 默认为risk:1)all:查询风险信息和地理位置;2)risk:查询风险信息;3)loc:查询地理位置 |
phone | String | 电话号码 | 否 | 18812345678 |
请求体示例
JSON
1{
2 "ip": "1.0.128.148",
3 "ipQueryStyle": "all",
4 "phone": "18610149206"
5}
3.1.2 正确返回体
编码 | 类型 | 含义 | 结构 |
---|---|---|---|
ret_code | String | 返回编码 | 0 |
ret_msg | String | 返回消息 | 操作成功 |
ret_data | dataInfo | 返回消息题 | 描述参考“dataInfo字段描述” |
dataInfo字段描述
字段 | 类型 | 是否必返 | 二级字段 | 备注 |
---|---|---|---|---|
req_id | String | 是 | 风控请求唯一标识 | |
ip | json | 否 | val: String,入参ip | 结构内部分别平铺了具体查询结果,如果未填写ip,此处将为"" |
level:String,风险级别 | 经过标签所包含的风险等级整合的结果:风险级别为按风险高低,取最小值 | |||
score,Integer,分数 | 分数 | |||
tags:List,风险标签 | 风险标签由查询风险设备库得到的标签和引擎决策判断出的标签组成 | |||
info:Map,标签详情 | 针对风险标签展示每个标签的详情,包含:产出时间(秒)和风险级别 | |||
detail:Map,画像详情 | 画像detail数据 | |||
loc: Map,ip地理信息 | ip地理信息,详细字段见下表 | |||
phone | json | 否 | val: String,入参ip | 结构内部分别平铺了具体查询结果,如果未填写phone,此处将为"" |
level:String,风险级别 | 经过标签所包含的风险等级整合的结果:风险级别为按风险高低,取最小值 | |||
score,Integer,分数 | 分数 | |||
tags:List,风险标签 | 风险标签由查询风险设备库得到的标签和引擎决策判断出的标签组成 | |||
info:Map,标签详情 | 针对风险标签展示每个标签的详情,包含:产出时间(秒)和风险级别 | |||
detail:Map,画像详情 | 画像detail数据 |
ip地理信息
字段 | 类型 | 备注 |
---|---|---|
country | String | 归属国家名字 |
province | String | 归属省份名字 |
city | String | 归属城市名字 |
continentCode | String | 归属大洲代码 |
isp | String | 归属运营商 |
latitude | String | 纬度 |
longitude | String | 经度 |
baseStation | String | 基站信息:基站 WIFI |
正常返回体示例
JSON
1{
2 "ret_code": "0",
3 "ret_msg": "操作成功",
4 "ret_data": {
5 "req_id": "73b0d05d-2b5b-4b98-8c21-afd9c0912516",
6 "phone": {
7 "val": "e63232c709a773cb6072ef38fe1256ac",
8 "score": "81",
9 "level": "2",
10 "detail": {},
11 "tags": ["majia"],
12 "info": {
13 "majia": ["1680741405", "2"]
14 }
15 },
16 "ip": {
17 "val": "197a4c1634b37d21d1c31ccf7b0560fc",
18 "score": "82",
19 "loc": {
20 "country": "",
21 "province": "",
22 "city": "",
23 "isp": "",
24 "latitude": "",
25 "baseStation": "",
26 "continentCode": "",
27 "longitude": ""
28 },
29 "level": "1",
30 "detail": {},
31 "tags": ["PROXY", "IDC"],
32 "info": {
33 "PROXY": ["1684080000", "1"],
34 "IDC": ["1684080000", "1"]
35 }
36 }
37 }
38}
3.1.3 异常返回体
编码 | 类型 | 含义 | 结构 |
---|---|---|---|
ret_code | String | 返回编码 | 参考返回码对照表中错误码列 |
ret_msg | String | 返回消息 | 参考返回码对照表中描述列 |
ret_data | dataInfo | 返回消息题 | 描述参考“dataInfo字段描述” |
dataInfo字段描述
字段 | 类型 | 是否必返 | 备注 |
---|---|---|---|
req_id | String | 是 | 风控请求唯一标识 |
异常返回体示例
JSON
1{
2 "request_id": "8fb5be8b-5cba-ed4e-d9e8-d87e32ccb217",
3 "ret_msg": "您暂未购买该服务",
4 "ret_code": 1000
5}
3.2 返回码对照
返回码 | 描述 |
---|---|
0 | 操作成功 |
1000 | 您暂未购买该服务 |
1001 | 认证失败 |
1004 | 服务超过最大QPS |
2001 | 消息体不正确 |
3000 | 系统内部错误 |