风险验证(必要)

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

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

API 方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8
认证参数
字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
partner_keyString合作方密钥必须由 TD 分配

请求参数

字段类型含义建议备注
channelString渠道标识必须由 TD 分配
session_idString会话 ID必须会话 ID 是网站服务器为特定用户在访问期间分配的唯一标识,通常可以用 Cookie、表单字段或 URL 的形式存储
decision_eventString风险验证时的业务节点必须枚举值:
marketing:营销
marketing_code:扫码
marketing_exchange:兑奖
send_gift:送礼
get_coupon:领券
withdraw:提现
invite:邀请
sms:短信
browse:浏览
activate:激活
like:点赞
comment:评论
favorite:收藏
event_timeString业务真实发生时间必须符合 ISO 8601 标准,格式 YYYY-MM-DDTHH:mm:ss.sssZ ,例如 2021-10-12T14:20:50.521+07:00
account_idString账户 ID条件必须:当账户注册(创建)后必须当账户不存在时可不传
terminalTerminal终端信息必须
extExt扩展信息条件必须:如果扩展信息用于本次决策则必须与 TD 约定好的扩展信息
event_detailObject业务事件信息必须与 decision_event 对应的业务事件数据对象

event_detail 业务事件数据与 decision_event 的映射关系

我们的 API 设计限制了每次请求只能涉及一个业务事件的数据。这意味着您无法同时传递多个不同的业务事件数据请求,例如营销和提现。遵守这一规则将有助于提高系统的性能和可靠性,并确保每个业务事件都能得到正确处理。

event_detaildecision_event
营销marketing
扫码marketing_code
兑奖marketing_exchange
送礼send_gift
领券get_coupon
提现withdraw
邀请invite
短信sms
浏览browse
激活activate
点赞like
评论comment
收藏favorite

请求示例

以营销事件为例

{
    "channel": "test",
    "session_id": "abc0123456789",
    "decision_event": "marketing",
    "event_time": "2021-10-12T14:20:50.521+07:00",
    "account_id": "123456789",
    "terminal": {
        "black_box": "aGPH1658920283672ropYaFxT7",
        "ip": "210.20.10.33"
    },
    "ext": {
        "ext_book_id": "LFOUHOFHOHFNOUH",
        "ext_book_num": 10
    },
    "event_detail": {
        "marketing": {
            "marketing_id": "X08938",
            "open_id": "o6_bmjrPTlm6_2sgVt7hMZOPfL2M",
            "open_id_type": "wechat",
            "begin_time": 1596358039000,
            "expire_time": 1616358039000
        }
    }
}

响应参数

字段类型含义建议备注
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
9004black_box或ip至少存在一个
9200系统异常
9201未知异常
9202content-type不合法

响应示例

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