列出欺诈网络 API - Didit 网络列表接口

curl

curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/?status=active,in_review&ordering=-risk_score' \
  -H 'x-api-key: YOUR_API_KEY'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();

for await (const item of didit.networks.list()) {
  console.log(item);
}

ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()

iter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

import me.didit.Didit;

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();

for (var item : client.networks().list()) {
    System.out.println(item);
}

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();

foreach ($didit->networks->list() as $item) {
    print_r($item->toArray());
}

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();

await foreach (var item in await client.Networks.ListAsync())
{
    Console.WriteLine(JsonSerializer.Serialize(item));
}

{
  "count": 123,
  "next": 123,
  "previous": 123,
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "network_id": "<string>",
      "name": "<string>",
      "status": "active",
      "risk": {
        "score": 123,
        "band": "low",
        "bar": 123
      },
      "pattern_types": [
        "exact_same_device"
      ],
      "signal_types": [
        "ip_address"
      ],
      "member_counts": {},
      "member_status": {},
      "signal_coverage": {},
      "first_activity_at": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z"
    }
  ],
  "sharing_mode": "global",
  "cross_org_available": true,
  "cross_org_unavailable_reason": null,
  "kpis": {
    "active": {},
    "in_review": {},
    "applicants_involved": {},
    "detected_this_period": {},
    "false_positive_rate": {}
  },
  "counts": {
    "scopes": {
      "all": 123,
      "identity": 123,
      "transactions": 123
    },
    "views": {
      "all": 123,
      "active": 123,
      "in_review": 123,
      "resolved": 123,
      "dismissed": 123,
      "mine": 123,
      "high_risk": 123
    },
    "facets": {
      "total": 123,
      "last_activity_days": {
        "7": 123,
        "30": 123,
        "90": 123
      },
      "risk_min": {
        "50": 123,
        "80": 123
      },
      "signal_types": {
        "ip_address": 123,
        "device": 123,
        "face": 123,
        "document_number": 123,
        "phone": 123,
        "email": 123,
        "address": 123
      },
      "priority": {
        "low": 123,
        "medium": 123,
        "high": 123,
        "none": 123
      },
      "assignee": {
        "me": 123,
        "unassigned": 123,
        "users": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "full_name": "<string>",
            "email": "<string>",
            "count": 123
          }
        ]
      },
      "has_case": 123,
      "min_size": {
        "10": 123
      }
    }
  }
}

GET

organization

{organization_id}

application

{application_id}

networks

curl

curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/?status=active,in_review&ordering=-risk_score' \
  -H 'x-api-key: YOUR_API_KEY'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
const didit = new Didit();

for await (const item of didit.networks.list()) {
  console.log(item);
}

ctx := context.Background()
// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
client := didit.NewClient()

iter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

import me.didit.Didit;

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
Didit client = new Didit();

for (var item : client.networks().list()) {
    System.out.println(item);
}

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
$didit = new DiditClient();

foreach ($didit->networks->list() as $item) {
    print_r($item->toArray());
}

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
// and DIDIT_APPLICATION_ID.
using var client = new DiditClient();

await foreach (var item in await client.Networks.ListAsync())
{
    Console.WriteLine(JsonSerializer.Serialize(item));
}

{
  "count": 123,
  "next": 123,
  "previous": 123,
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "network_id": "<string>",
      "name": "<string>",
      "status": "active",
      "risk": {
        "score": 123,
        "band": "low",
        "bar": 123
      },
      "pattern_types": [
        "exact_same_device"
      ],
      "signal_types": [
        "ip_address"
      ],
      "member_counts": {},
      "member_status": {},
      "signal_coverage": {},
      "first_activity_at": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z"
    }
  ],
  "sharing_mode": "global",
  "cross_org_available": true,
  "cross_org_unavailable_reason": null,
  "kpis": {
    "active": {},
    "in_review": {},
    "applicants_involved": {},
    "detected_this_period": {},
    "false_positive_rate": {}
  },
  "counts": {
    "scopes": {
      "all": 123,
      "identity": 123,
      "transactions": 123
    },
    "views": {
      "all": 123,
      "active": 123,
      "in_review": 123,
      "resolved": 123,
      "dismissed": 123,
      "mine": 123,
      "high_risk": 123
    },
    "facets": {
      "total": 123,
      "last_activity_days": {
        "7": 123,
        "30": 123,
        "90": 123
      },
      "risk_min": {
        "50": 123,
        "80": 123
      },
      "signal_types": {
        "ip_address": 123,
        "device": 123,
        "face": 123,
        "document_number": 123,
        "phone": 123,
        "email": 123,
        "address": 123
      },
      "priority": {
        "low": 123,
        "medium": 123,
        "high": 123,
        "none": 123
      },
      "assignee": {
        "me": 123,
        "unassigned": 123,
        "users": [
          {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "full_name": "<string>",
            "email": "<string>",
            "count": 123
          }
        ]
      },
      "has_case": 123,
      "min_size": {
        "10": 123
      }
    }
  }
}

列出为您的组织检测到的欺诈网络。默认情况下，列表按风险评分从高到低排序，然后按最近活动时间从近到远排序。控制台网络列表中可用的每个筛选条件都以查询参数的形式提供，包括自由文本搜索参数 q，以及相同的状态、信号、模式和风险等级区间筛选标签。 assignee、priority、risk_min 和 has_case 参数分别对应 counts.facets 统计的负责人、优先级、最低风险和关联案件选项。 assignee=me 需要控制台成员令牌；使用 API 密钥时会返回 400。

沙盒应用永远不会有网络。聚类仅基于生产数据运行。

共享模式与跨组织信号

每个响应都包含您组织的 sharing_mode、cross_org_available 和 cross_org_unavailable_reason。

字段	含义
`sharing_mode`	组织的跨组织共享模式。只有 `global` 会在组织之间比较网络；`private` 和 `off` 仅将网络限定在本组织的历史记录内。
`cross_org_available`	跨组织信号是否适用于您的组织。它需要同时满足 Enterprise 套餐和 `global` 共享模式。
`cross_org_unavailable_reason`	当您的套餐不包含跨组织欺诈网络功能（需要 Enterprise 套餐）时为 `plan`，无论您的共享模式如何。当套餐包含该功能但共享模式为 `private` 或 `off` 时为 `sharing_mode`。当 `cross_org_available` 为 `true` 时为 `null`。

系统会先检查套餐：如果未达到 Enterprise 套餐，即使共享模式为 global，原因也是 plan。

统计数据与 summary 参数

kpis 汇总符合您筛选条件的网络，counts 汇总您的应用可见的所有网络。两者的计算开销都比页面本身大。如果您只需要页面数据和 count，请传入 summary=false：此时响应会省略 kpis 和 counts。 summary 只接受 true 或 false；其他任何值都会返回 400。 counts 包含网络列表各视图和筛选选项背后的数值，每个网络只计算一次：

键	统计内容
`scopes`	所有可见网络（`all`），并拆分为 `transactions`（每个成员都是交易方）和 `identity`（其他所有网络）。
`views`	所选 `scope`（`all`）内的可见网络，按状态（`active`、`in_review`、`resolved`、`dismissed`）、分配给当前控制台成员的网络（`mine`），以及 `high_risk`（风险评分为 80 或以上且未被驳回的网络）统计。
`facets`	所选 `scope` 和 `status` 视图（`total`）中的网络，按最近活动时间（`last_activity_days`：7、30、90）、最低风险（`risk_min`：50、80）、信号类型、优先级（包括 `none`）、负责人（`me`、`unassigned`，以及 `users` 中每位负责人各一项）、您的应用已为其创建案件的网络（`has_case`），以及成员数至少为 10 的网络（`min_size`）统计。

除 scope 和 status 以外的筛选条件不会改变 counts。对于 API 密钥，views.mine 和 facets.assignee.me 始终为 0，因为没有控制台成员在调用。

访问权限

网络相关端点需要具有完整访问权限的 API 密钥。访问权限受限的密钥会收到 403。控制台成员令牌需要 list:networks 权限。如果您的组织未启用网络功能，所有网络端点都会返回 403，并附带 "code": "networks_not_entitled"。

​共享模式与跨组织信号

​统计数据与 summary 参数

​访问权限

​相关内容

授权

路径参数

查询参数

响应

共享模式与跨组织信号

统计数据与 summary 参数

访问权限

相关内容