接入文档
数据智能产品体系
FinStack-IDN
FinStack-IDN

# FinStack-IDN 接口文档

# 一、接口描述

通过三要素入参,返回多头基础特征、时间分布特征、多头升温等

# 二、接口地址

https://api-idn.yljz.com/finauth/v3/riskinfo/mh

# 三、调用方法

POST(需使用form-data格式请求)

# 四、请求参数

可选/必选 参数英文名 类型 参数说明
必选 sign String 签名信息,构建方法见本文档最下方
必选 sign_version String 签名算法版本号,目前仅支持:"hmac_sha1"
必选 id_number
String 身份证号(md5/sha256/sm3)
【注意:如有字母需大写】
必选 phone String 身份证号(md5/sha256/sm3)
【注意:不需要加国家码】
必选(二选一)
face_image_file String 人脸图片(不能超过2M)
face_image_base64 String 人脸图片Base64
可选
hash_type
String 身份证及手机号的哈希方式:
md5(默认)
sha256
sm3

# 五、产品出参

序号 参数英文名 参数中文名 类型 参数说明
1 org_cnt_1d 近1天查询机构数 integer 0+
2 org_cnt_3d 近3天查询机构数 integer 0+
3 org_cnt_7d 近7天查询机构数 integer 0+
4 org_cnt_14d 近14天查询机构数 integer 0+
5 org_cnt_21d 近21天查询机构数 integer 0+
6 org_cnt_30d 近30天查询机构数 integer 0+
7 org_cnt_90d 近90天查询机构数 integer 0+
8 query_cnt_1d 近1天查询次数 integer 0+
9 query_cnt_3d 近3天查询次数 integer 0+
10 query_cnt_7d 近7天查询次数 integer 0+
11 query_cnt_14d 近14天查询次数 integer 0+
12 query_cnt_21d 近21天查询次数 integer 0+
13 query_cnt_30d 近30天查询次数 integer 0+
14 query_cnt_90d 近90天查询次数 integer 0+
15 last_query_days 最近一次查询距今天数 integer [1,90]
16 first_query_days 首次查询距今天数 integer [1,90]
17 active_days_7d 近7天有查询行为天数 integer 0-7
18 active_days_30d 近30天有查询行为天数 integer 0-30
19 max_daily_query_cnt_7d 近7天单日最高查询次数 integer 0+
20 max_daily_query_cnt_30d 近30天单日最高查询次数 integer 0+
21 night_query_ratio_7d 近7天夜间查询占比 decimal 0-1 / null
22 night_query_ratio_30d 近30天夜间查询占比 decimal 0-1 / null
23 avg_query_interval_7d 近7天平均查询间隔 decimal 0+ / null
24 avg_query_interval_30d 近30天平均查询间隔 decimal 0+ / null
25 query_time_variance_7d 近7天查询时间方差 decimal 0+ / null
26 query_time_variance_30d 近30天查询时间方差 decimal 0+ / null
27 top1_org_query_ratio_7d 近7天查询最多机构次数占比 decimal 0-1 / null
28 top1_org_query_ratio_30d 近30天查询最多机构次数占比 decimal 0-1 / null
29 new_org_cnt_7d 近7天新增查询机构数 integer 0+
30 new_org_cnt_30d 近30天新增查询机构数 integer 0+
31 same_org_repeat_cnt_7d 近7天同机构重复查询次数 integer 0+
32 same_org_repeat_cnt_30d 近30天同机构重复查询次数 integer 0+
33 continuous_2d_query_cnt_7d 近7天连续2日查询次数 integer 0+
34 continuous_2d_query_cnt_30d 近30天连续2日查询次数 integer 0+
35 continuous_3d_query_cnt_7d 近7天连续3日查询次数 integer 0+
36 continuous_3d_query_cnt_30d 近30天连续3日查询次数 integer 0+
37 continuous_2d_multi_org_cnt_7d 近7天连续2日及以上多机构查询次数 integer 0+
38 continuous_2d_multi_org_cnt_30d 近30天连续2日及以上多机构查询次数 integer 0+
39 continuous_3d_multi_org_cnt_7d 近7天连续3日及以上多机构查询次数 integer 0+
40 continuous_3d_multi_org_cnt_30d 近30天连续3日及以上多机构查询次数 integer 0+
41 query_cnt_ratio_1d_3d 近1天/近3天查询次数比例 decimal 0+ / null
42 query_cnt_ratio_3d_7d 近3天/近7天查询次数比例 decimal 0+ / null
43 query_cnt_ratio_7d_14d 近7天/近14天查询次数比例 decimal 0+ / null
44 query_cnt_ratio_3d_14d 近3天/近14天查询次数比例 decimal 0+ / null
45 query_cnt_ratio_7d_30d 近7天/近30天查询次数比例 decimal 0+ / null
46 query_avg_ratio_1d_3d 近1天日均/近3天日均查询次数比例 decimal 0+ / null
47 query_avg_ratio_3d_7d 近3天日均/近7天日均查询次数比例 decimal 0+ / null
48 query_avg_ratio_7d_14d 近7天日均/近14天日均查询次数比例 decimal 0+ / null
49 query_avg_ratio_3d_14d 近3天日均/近14天日均查询次数比例 decimal 0+ / null
50 query_avg_ratio_7d_30d 近7天日均/近30天日均查询次数比例 decimal 0+ / null
51 org_cnt_ratio_1d_3d 近1天/近3天查询机构数比例 decimal 0+ / null
52 org_cnt_ratio_3d_7d 近3天/近7天查询机构数比例 decimal 0+ / null
53 org_cnt_ratio_7d_14d 近7天/近14天查询机构数比例 decimal 0+ / null
54 org_cnt_ratio_3d_14d 近3天/近14天查询机构数比例 decimal 0+ / null
55 org_cnt_ratio_7d_30d 近7天/近30天查询机构数比例 decimal 0+ / null
56 org_avg_ratio_1d_3d 近1天日均/近3天日均查询机构数比例 decimal 0+ / null
57 org_avg_ratio_3d_7d 近3天日均/近7天日均查询机构数比例 decimal 0+ / null
58 org_avg_ratio_7d_14d 近7天日均/近14天日均查询机构数比例 decimal 0+ / null
59 org_avg_ratio_3d_14d 近3天日均/近14天日均查询机构数比例 decimal 0+ / null
60 org_avg_ratio_7d_30d 近7天日均/近30天日均查询机构数比例 decimal 0+ / null

# 六、HTTP状态码

http状态码 错误信息 意义说明
200 正常值,服务器成功返回用户请求的数据
400 INVALID_IMAGE image超出2M
400 IMAGE_ERROR_UNSUPPORTED_FORMAT 上传的图像无法解析
400 FACE_NOT_FOUND 未找到对应数据
400 BAD_ARGUMENTS:<key> 某个参数解析出错(比如必须是数字,但是输入的是非数字字符串,或者长度过长)
400 MISSING_ARGUMENTS:<key> 缺少某个必选参数
403 AUTHENTICATION_ERROR 无效签名
403 AUTHENTICATION_ERROR:<reason> api_key被停用、调用次数超限、没有调用此API的权限,或者没有以当前方式调用此API的权限 <reason>取值:
- API_KEY_BE_DISCONTINUED:api_key被停用
- IP_NOT_ALLOWED:不允许访问的IP
- LIMIT_REACHED:测试api_key调用量已达到上限
- DENIED:无权限调用当前API
- EXPIRED_SIGN:签名已过期
- INVALID_SIGN:无效签名 其他可能的错误码
403 CONCURRENCY_LIMIT_EXCEEDED 并发数超过限制
404 API_NOT_FOUND 所调用的API不存在
500 INTERNAL_ERROR 如果持续出现此类错误,请及时联系客服或商务

# 七、示例代码

成功示例:

JSON
{
    "request_id": "1786415523,cc1a65c1-b7b9-483f-b349-019a94c8db24",
    "time_used": 487,
    "result": {
        "active_days_30d": 1,
        "active_days_7d": 1,
        "avg_query_interval_30d": 0,
        "avg_query_interval_7d": 0,
        "continuous_2d_multi_org_cnt_30d": 0,
        "continuous_2d_multi_org_cnt_7d": 0,
        "continuous_2d_query_cnt_30d": 0,
        "continuous_2d_query_cnt_7d": 0,
        "continuous_3d_multi_org_cnt_30d": 0,
        "continuous_3d_multi_org_cnt_7d": 0,
        "continuous_3d_query_cnt_30d": 0,
        "continuous_3d_query_cnt_7d": 0,
        "first_query_days": 2,
        "last_query_days": 2,
        "max_daily_query_cnt_30d": 3,
        "max_daily_query_cnt_7d": 3,
        "new_org_cnt_30d": 3,
        "new_org_cnt_7d": 3,
        "night_query_ratio_30d": 0,
        "night_query_ratio_7d": 0,
        "org_avg_ratio_1d_3d": 0,
        "org_avg_ratio_3d_14d": 4.666667,
        "org_avg_ratio_3d_7d": 2.333333,
        "org_avg_ratio_7d_14d": 2,
        "org_avg_ratio_7d_30d": 4.285714,
        "org_cnt_14d": 3,
        "org_cnt_1d": 0,
        "org_cnt_21d": 3,
        "org_cnt_30d": 3,
        "org_cnt_3d": 3,
        "org_cnt_7d": 3,
        "org_cnt_90d": 3,
        "org_cnt_ratio_1d_3d": 0,
        "org_cnt_ratio_3d_14d": 1,
        "org_cnt_ratio_3d_7d": 1,
        "org_cnt_ratio_7d_14d": 1,
        "org_cnt_ratio_7d_30d": 1,
        "query_avg_ratio_1d_3d": 0,
        "query_avg_ratio_3d_14d": 4.666667,
        "query_avg_ratio_3d_7d": 2.333333,
        "query_avg_ratio_7d_14d": 2,
        "query_avg_ratio_7d_30d": 4.285714,
        "query_cnt_14d": 3,
        "query_cnt_1d": 0,
        "query_cnt_21d": 3,
        "query_cnt_30d": 3,
        "query_cnt_3d": 3,
        "query_cnt_7d": 3,
        "query_cnt_90d": 3,
        "query_cnt_ratio_1d_3d": 0,
        "query_cnt_ratio_3d_14d": 1,
        "query_cnt_ratio_3d_7d": 1,
        "query_cnt_ratio_7d_14d": 1,
        "query_cnt_ratio_7d_30d": 1,
        "query_time_variance_30d": 0,
        "query_time_variance_7d": 0,
        "same_org_repeat_cnt_30d": 1,
        "same_org_repeat_cnt_7d": 1,
        "top1_org_query_ratio_30d": 0.333333,
        "top1_org_query_ratio_7d": 0.333333
    }
}

失败示例:

Plain
{
    "request_id": "1786415623,b14afd55-45ae-4fff-8418-3c403e5e2154",
    "time_used": 515,
    "error_message": "FACE_NOT_FOUND"
}