离线回捞模型 API 是用于将 TD 离线回捞模型产出的风险数据,主动推送到您订阅的 API 地址,以便于您的业务系统接收到结果后进行进一步的操作流程,如在授信结果出来之前取消该用户的贷款申请等。
TD 将 T+1 产出离线回捞数据,每天早上或凌晨将回捞数据通过本 API 推送给您。
API 方式
Base URL
您提供给 TD 的订阅 API 地址。
API
URL | 请求方式 | Content-Type | 输出格式 | 字符集 |
---|---|---|---|---|
api-base-url?partner_code=xxx×tamp=xxx&access_key=xxx&sign=xxx | POST | application/json | JSON | UTF-8 |
认证参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
partner_code | String | 合作方标识 | 必须 | 由 TD 分配 |
timestamp | String | 当前时间戳 | 必须 | 毫秒级 |
access_key | String | access key | 必须 | 由 TD 分配 |
sign | String | 签名 | 必须 |
sign 生成方式
sign = HmacSHA1(partner_code+timestamp+access_key,access_secret)
其中 access_secret 由 TD 分配
headers
参数名 | 参数值 | 建议 |
---|---|---|
Content-Type | application/json | 必须 |
推送请求参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
name | String | 姓名 | 必须 | |
id_type | String | 证件类型 | 必须 | 枚举值:1. identity_card: 身份证2. passport:护照3. driving_licence 驾照4. birth_certificate:出生证明5. others:其他 |
id_number | String | 身份证 | 必须 | |
country_code | Integer | 手机国家区号 | 建议 | 符合国际电信联盟 E.164 标准,不含 + 号和前缀 0,如 86 |
phone_number | String | 手机号 | 必须 | |
sequence_id | String | 原始请求 id | 必须 | 如果对接的国际保镖,则该值为保镖 id |
result_type | String | 结果类型 | 必须 | 如fraud |
reason | String | 风险原因 | 必须 | 黑样本关联、团伙异常等 |
推送请求示例
JSON
{
"sequence_id": "164877716577086****6307055",
"phone_number": "861234***5",
"name": "Jack Simth",
"id_number": "xxxxx",
"result_type": "fraud",
"reason": "black association"
}
响应参数
您的业务系统在收到推送请求后需要响应的参数
字段 | 类型 | 含义 | 建议 | 备注 |
---|---|---|---|---|
code | Integer | API 状态码 | 必须 | |
message | String | 状态信息 | 必须 | 在 API 异常状态下会输出具体的异常原因 |
API 状态码
code | 含义 |
---|---|
200 | 成功 |
响应示例
{
"code": 200,
"message": ""
}
说明:若您返回的状态码非 200,我们会重试 3 次,3 次均失败则不会再推送。