قائمة شبكات الاحتيال API

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
      }
    }
  }
}

اعرض شبكات الاحتيال التي رُصدت لمؤسستك. يكون الترتيب افتراضياً حسب درجة المخاطر، من الأعلى إلى الأدنى، ثم حسب أحدث نشاط. تُتاح كل عوامل التصفية الموجودة في قائمة Networks في Console كمعاملات استعلام، بما فيها البحث النصي الحر عبر q ونفس شرائح الحالة والإشارة والنمط ونطاق المخاطر. تطابق المعاملات assignee وpriority وrisk_min وhas_case خيارات المكلَّف والأولوية والحد الأدنى للمخاطر والحالة المرتبطة التي يحسبها counts.facets. يتطلب assignee=me رمز وصول لعضو Console، ومع مفتاح API يُرجع 400.

لا تحتوي تطبيقات البيئة التجريبية (sandbox) على شبكات أبداً. يعمل التجميع على بيانات الإنتاج فقط.

وضع المشاركة والإشارات عبر المؤسسات

تتضمّن كل استجابة القيم sharing_mode وcross_org_available وcross_org_unavailable_reason الخاصة بمؤسستك.

الحقل	المعنى
`sharing_mode`	وضع مشاركة المؤسسة عبر المؤسسات. لا يقارن الشبكات بين المؤسسات سوى وضع `global`؛ أما الوضعان `private` و`off` فيُبقيانها ضمن سجل المؤسسة الخاص.
`cross_org_available`	ما إذا كانت الإشارات عبر المؤسسات تنطبق على مؤسستك. تتطلب خطة Enterprise ووضع المشاركة `global` معاً.
`cross_org_unavailable_reason`	القيمة `plan` عندما لا تتضمن خطتك شبكة الاحتيال عبر المؤسسات (وتتطلب خطة Enterprise)، بغض النظر عن وضع المشاركة. القيمة `sharing_mode` عندما تتضمنها الخطة لكن وضع المشاركة لديك `private` أو `off`. القيمة `null` عندما تكون `cross_org_available` مساوية لـ`true`.

يُفحص مستوى الخطة أولاً: إذا كانت الخطة أدنى من Enterprise، فالسبب هو plan حتى لو كان وضع المشاركة لديك global.

العدادات ومعامل summary

تجمع kpis الشبكات التي تطابق عوامل التصفية لديك، وتجمع counts كل شبكة يمكن لتطبيقك رؤيتها، ولذلك تكلّف kpis و counts أكثر من الصفحة نفسها. مرّر summary=false عندما تحتاج إلى الصفحة وcount فقط: عندها تحذف الاستجابة kpis وcounts. يقبل summary القيمتين true أو false فقط، وأي قيمة أخرى تُرجع 400. تحمل counts الأرقام التي تقوم عليها طرق عرض القائمة وخيارات التصفية، ويُحسب كل شبكة مرة واحدة فقط:

المفتاح	ما يحتسبه
`scopes`	كل شبكة مرئية (`all`)، مقسّمة إلى `transactions` (كل أعضائها أطراف في معاملات) و`identity` (كل شبكة أخرى).
`views`	الشبكات المرئية ضمن `scope` المحدد (`all`)، حسب الحالة (`active` و`in_review` و`resolved` و`dismissed`)، والمُكلّفة لعضو Console الذي يُجري الاستدعاء (`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. القيمتان views.mine وfacets.assignee.me تساويان دائماً 0 مع مفتاح API، لأنه لا يوجد عضو Console يُجري الاستدعاء.

الوصول

تتطلب endpoints الخاصة بـ Networks مفتاح API بصلاحية كاملة. المفتاح ذو الوصول المقيّد يُرجع 403. يتطلب رمز وصول لعضو Console الإذن list:networks. عندما لا تكون Networks مفعّلة لمؤسستك، تُرجع كل endpoint في Networks الاستجابة 403 مع "code": "networks_not_entitled".

ذات صلة

التفويضات

x-api-key

string

header

مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات المسار

organization_id

string<uuid>

مطلوب

UUID الخاص بالمؤسسة.

application_id

string<uuid>

مطلوب

معرّف UUID للتطبيق.

معلمات الاستعلام

status

string

الحالات مفصولة بفواصل لتضمينها: active,in_review,resolved,dismissed. احذف المعامل لاستبعاد الحالات ذات الحالة dismissed.

scope

enum<string>

يحتفظ transactions بالشبكات التي يكون جميع أعضائها أطرافاً في المعاملة؛ ويحتفظ identity بجميع الشبكات الأخرى. لا ترسله لعرض كليهما. كما أنه يضيّق نطاق counts.views وcounts.facets. أي قيمة أخرى تُرجع 400.

الخيارات المتاحة:

identity,

transactions

signal_type

string

أنواع الإشارات مفصولة بفواصل: ip_address,device,face,document_number,phone,email,address.

pattern_type

string

أنواع الأنماط مفصولة بفواصل، مثل exact_same_device,same_email.

risk_band

string

نطاقات مفصولة بفواصل: low,medium,high.

min_size

integer

الحد الأدنى لعدد الأعضاء.

max_size

integer

الحد الأقصى لعدد الأعضاء.

assignee

string

المعيّنون مفصولون بفواصل: unassigned، أو عناوين البريد الإلكتروني للأعضاء (المطابقة غير حساسة لحالة الأحرف)، أو me لعضو لوحة التحكم الذي يجري الاستدعاء. تطابق الشبكة أي قيمة. تتطلب me token لعضو لوحة التحكم: يحصل مفتاح API على 400 {"assignee": ["\"me\" needs a user token; an API key has no assignee identity."]}.

priority

string

الأولويات مفصولة بفواصل: low، أو medium، أو high، أو none للشبكات التي ليس لها أولوية. ترجع أي قيمة أخرى الخطأ 400 {"priority": "Unknown priority: <values>."}.

risk_min

integer

الحد الأدنى لدرجة المخاطر، عدد صحيح من 0 إلى 100. أي قيمة ليست عددًا صحيحًا تُرجع الرمز 400 {"risk_min": "Use a whole number from 0 to 100."}.

النطاق المطلوب: 0 <= x <= 100

has_case

boolean

تُبقي القيمة true على الشبكات التي فتح تطبيقك حالة لها، بينما تُبقي القيمة false على الشبكات الأخرى. وتُتجاهل أي قيمة أخرى.

date_from

string<date>

الحد الأدنى لـ last_activity_at (تاريخ أو تاريخ ووقت وفقاً لمعيار ISO 8601).

date_to

string<date>

الحد الأعلى لـ first_activity_at (تاريخ أو تاريخ ووقت بتنسيق ISO 8601).

string

بحث بنص حر عبر اسم الشبكة وأسماء الأعضاء وnetwork_id (N-0001) ورموز pattern_type الدقيقة.

ordering

string

واحد من risk_score، -risk_score، last_activity_at، -last_activity_at، first_activity_at، -first_activity_at، network_number، -network_number. القيمة الافتراضية هي -risk_score,-last_activity_at.

limit

integer

افتراضي:100

حجم الصفحة، 1-500. القيمة الافتراضية هي 100.

النطاق المطلوب: 1 <= x <= 500

offset

integer

افتراضي:0

إزاحة تستند إلى الصفر للسجل الأول.

النطاق المطلوب: x >= 0

summary

boolean

افتراضي:true

تُرجع القيمة false الصفحة وقيمة count الخاصة بها فقط، دون kpis وcounts. القيمة الافتراضية هي true. يؤدي إرسال أي قيمة بخلاف true أو false إلى إرجاع الرمز 400.

الاستجابة

قائمة الشبكات مقسمة إلى صفحات، مع وضع المشاركة الخاص بالمؤسسة والتوافر عبر المؤسسات، بالإضافة إلى kpis و counts ما لم يكن summary=false.

count

integer

مطلوب

integer | null

مطلوب

إزاحة الصفحة التالية، أو null في الصفحة الأخيرة.

integer | null

مطلوب

results

object[]

مطلوب

Show child attributes

وضع المشاركة بين المؤسسات الخاص بالمؤسسة. تقارن القيمة global فقط الشبكات عبر المؤسسات؛ بينما تقصر القيمتان private وoff المقارنة على سجل المؤسسة الخاص فقط.

الخيارات المتاحة:

off,

private,

global

مثال:

"global"

cross_org_available

boolean

مطلوب

ما إذا كانت الإشارات المشتركة بين المؤسسات تسري على هذه المؤسسة. تتطلب كلاً من خطة Enterprise ووضع المشاركة global.

مثال:

true

cross_org_unavailable_reason

enum<string> | null

مطلوب

سبب عدم تطبيق الإشارات المشتركة بين المؤسسات، ويتم التحقق منها بهذا الترتيب. plan: خطة المؤسسة لا تتضمن شبكة مكافحة الاحتيال المشتركة بين المؤسسات (تتطلب خطة Enterprise)، أياً كان وضع المشاركة. sharing_mode: تتضمن الخطة الميزة، لكن وضع المشاركة هو private أو off. تكون Null عندما تكون قيمة cross_org_available هي true.

الخيارات المتاحة:

plan,

sharing_mode

مثال:

null

kpis

object

كل مفتاح هو {value, delta} على النتائج المطابقة للتصفيات الحالية. يُحذف عندما يكون summary=false.

Show child attributes

counts

object

أعداد الشبكات لطرق عرض القائمة وخيارات التصفية، مع احتساب كل شبكة مرة واحدة فقط. يتم إرجاعها فقط عندما لا تكون قيمة summary هي false. تحسب scopes كل شبكة مرئية للتطبيق. وتحسب views الشبكات المرئية داخل scope المحدد. بينما تحسب facets الشبكات في scope المحدد وعرض status (تُستبعد الشبكات المتجاهلة ما لم يتضمنها status). لا تغيّر عوامل تصفية القائمة الأخرى هذه الأعداد.

Show child attributes

آخر تعديل في ٧ نوفمبر ٢٠٢٦

​وضع المشاركة والإشارات عبر المؤسسات

​العدادات ومعامل summary

​الوصول

​ذات صلة

التفويضات

معلمات المسار

معلمات الاستعلام

الاستجابة

وضع المشاركة والإشارات عبر المؤسسات

العدادات ومعامل summary

الوصول

ذات صلة