API Reference
English

风险验证(必要)

营销反欺诈风险验证 API 用于您实时获取我们的风险验证结果。

为了有效地阻止欺诈发生并避免活动资金损失,建议您在发放活动优惠之前发送请求进行风险验证,或在发放活动优惠后但在优惠兑现之前立即发送请求进行风险验证。这样可以帮助您保护活动资金的安全性,并确保只有合法的用户能够获得优惠。

API 方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8

示例:https://cn-efficient.apitd.net/fraud/verification/v3?partner_code=test_code&partner_key=test_key

认证参数
字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
partner_keyString合作方密钥必须由 TD 分配

请求参数

字段类型含义建议备注
channelString渠道标识必须由 TD 分配
session_idString会话 ID必须会话 ID 是网站服务器为特定用户在访问期间分配的唯一标识,通常可以用 Cookie、表单字段或 URL 的形式存储
decision_eventString风险验证时的业务节点必须枚举值:
register:注册
login:登录
marketing:营销
order_create:创建订单
order_payment:支付订单
event_timeString业务真实发生时间必须符合 ISO 8601 标准,格式 YYYY-MM-DDTHH:mm:ss.sssZ ,例如 2021-10-12T14:20:50.521+07:00
account_idString账户 ID强烈建议
country_codeInteger国家区号强烈建议符合国际电信联盟 E.164 标准,不含 + 号和前缀 0,如 86
phone_numberString手机号 / 电话号码强烈建议不含 + 号和前缀
emailString邮箱强烈建议
ipString公网 IP 地址强烈建议支持 IPV4 和 IPV6
imeiString设备 IMEI强烈建议
oaidString设备 OAID强烈建议
idfaString设备 IDFA强烈建议
gaidString设备 GAID强烈建议

请求示例

以营销事件为例

{
    "channel": "test",
    "decision_event": "register", 
    "event_time": "2021-10-12T14:20:50.521+07:00",
    "account_id": "123456789",
    "country_code": 86,
    "phone_number": "18700001111",
    "email": "[email protected]",
    "ip": "210.20.10.33",
    "oaid": "xxxx"
}

响应参数

字段类型含义建议备注
codeIntegerAPI 状态码必须
messageString状态信息必须在 API 异常状态下会输出具体的异常原因
sequence_idString响应唯一码必须用于跟踪每次请求记录的唯一标识
scoreInteger风险分必须范围为 0 - 100
resultString决策结果必须枚举值:
decline:拒绝
review:核验
accept:通过
reasonsArray决策原因列表必须
idString决策原因 ID必须每个决策原因都会有一个唯一编码
reasonString决策原因必须

API 状态码

code含义
200成功
301未购买此服务
302流量已被禁用
303流量不足
304服务已过期
305日流量已封顶
9001{字段名}为空
9002{字段名}参数校验错误
9003{字段名}参数长度或者大小超过1024
9200系统异常
9201未知异常
9202content-type不合法

响应示例

{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "score": 90,
    "result": "decline",
    "reasons": [
        {
            "id": "IDRBVBBY",
            "reason": "短时间内操作频率异常"
        }
    ]
}