身份风险验证

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

API 方式#

Base URL#

中国节点：https://cn-efficient.apitd.net/fraud/identity/v3
美国节点：https://us-efficient.apitd.net/fraud/identity/v3
新加坡节点：https://sg-efficient.apitd.net/fraud/identity/v3
德国节点：https://de-efficient.apitd.net/fraud/identity/v3

API#

URL	请求方式	Content-Type	输出格式	字符集
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

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

认证参数

字段	类型	含义	建议	备注
partner_code	String	合作方标识	必须	由 TD 分配
partner_key	String	合作方密钥	必须	由 TD 分配

请求参数#

字段	类型	含义	建议	备注
channel	String	渠道标识	必须	由 TD 分配
session_id	String	会话 ID	必须	会话 ID 是网站服务器为特定用户在访问期间分配的唯一标识，通常可以用 Cookie、表单字段或 URL 的形式存储
decision_event	String	风险验证时的业务节点	必须	枚举值： register：注册 login：登录 modify：个人信息变更
event_time	String	业务真实发生时间	必须	符合 ISO 8601 标准，格式 YYYY-MM-DDTHH:mm:ss.sssZ ，例如 2021-10-12T14:20:50.521+07:00
account_id	String	账户 ID	必须
terminal	Terminal	终端信息	必须
ext	Ext	扩展信息	条件必须：如果扩展信息用于本次决策则必须	与 TD 约定好的扩展信息
event_detail	Object	业务事件信息	必须	与 decision_event 对应的业务事件数据对象

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

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

event_detail	decision_event
注册	register
登录	login
个人信息变更	modify

请求示例#

以注册事件为例

JSON

{
    "channel": "test",
    "session_id": "abc0123456789",
    "decision_event": "register",
    "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"

响应参数#

字段	类型	含义	建议	备注
code	Integer	API 状态码	必须
message	String	状态信息	必须	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	必须	用于跟踪每次请求记录的唯一标识
score	Integer	风险分	必须	范围为 0 - 100
result	String	决策结果	必须	枚举值： decline：拒绝 review：核验 accept：通过
reasons	Array	决策原因列表	必须
id	String	决策原因 ID	必须	每个决策原因都会有一个唯一编码
reason	String	决策原因	必须

API 状态码

code	含义
200	成功
301	未购买此服务
302	流量已被禁用
303	流量不足
304	服务已过期
305	日流量已封顶
9001	{字段名}为空
9002	{字段名}参数校验错误
9003	{字段名}参数长度或者大小超过1024
9004	black_box或ip至少存在一个
9200	系统异常
9201	未知异常
9202	content-type不合法
9203	没有对应的策略配置
9204	格式不支持
9205	get请求不支持
9206	系统环境异常

响应示例#

JSON

{
    "code": 200,
    "message": "",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "score": 90,
    "result": "decline",
    "reasons": [
        {
            "id": "IDMQ0QB2",
            "reason": "存在团伙风险行为"
        }
    ]
}

URL

请求方式

Content-Type

输出格式

字符集

api-base-url?partner_code=xxx&partner_key=xxx

POST

application/json

JSON

UTF-8

字段

类型

含义

建议

备注

partner_code

String

合作方标识

必须

由 TD 分配

partner_key

String

合作方密钥

必须

由 TD 分配

字段

类型

含义

建议

备注

channel

String

渠道标识

必须

由 TD 分配

session_id

String

会话 ID

必须

会话 ID 是网站服务器为特定用户在访问期间分配的唯一标识，通常可以用 Cookie、表单字段或 URL 的形式存储

decision_event

String

风险验证时的业务节点

必须

枚举值：
register：注册
login：登录
modify：个人信息变更

event_time

String

业务真实发生时间

必须

符合 ISO 8601 标准，格式 YYYY-MM-DDTHH:mm:ss.sssZ ，例如 2021-10-12T14:20:50.521+07:00

account_id

String

账户 ID

必须

terminal

Terminal

终端信息

必须

ext

Ext

扩展信息

条件必须：如果扩展信息用于本次决策则必须

与 TD 约定好的扩展信息

event_detail

Object

业务事件信息

必须

与 decision_event 对应的业务事件数据对象

event_detail

decision_event

个人信息变更

modify

{ "channel": "test", "session_id": "abc0123456789", "decision_event": "register", "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"

字段

类型

含义

建议

备注

code

Integer

API 状态码

必须

message

String

状态信息

必须

在 API 异常状态下会输出具体的异常原因

sequence_id

String

响应唯一码

必须

用于跟踪每次请求记录的唯一标识

score

Integer

风险分

必须

范围为 0 - 100

result

String

决策结果

必须

枚举值：
decline：拒绝
review：核验
accept：通过

reasons

Array

决策原因列表

必须

String

决策原因 ID

必须

每个决策原因都会有一个唯一编码

reason

String

决策原因

必须

code

含义

200

成功

301

未购买此服务

302

流量已被禁用

303

流量不足

304

服务已过期

305

日流量已封顶

9001

{字段名}为空

9002

{字段名}参数校验错误

9003

{字段名}参数长度或者大小超过1024

9004

black_box或ip至少存在一个

9200

系统异常

9201

未知异常

9202

content-type不合法

9203

没有对应的策略配置

9204

格式不支持

9205

get请求不支持

9206

系统环境异常

{ "code": 200, "message": "", "sequence_id": "1648777165770866F82AC7F326307055", "score": 90, "result": "decline", "reasons": [ { "id": "IDMQ0QB2", "reason": "存在团伙风险行为" } ] }