> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# फ़्रॉड नेटवर्क सूची API
> Didit में आपके संगठन के फ़्रॉड नेटवर्क की सूची पाएँ, स्थिति, सिग्नल, पैटर्न, जोखिम स्तर, आकार और तिथि से फ़िल्टर करें, साझाकरण मोड सहित।
नेटवर्क सूची API प्रॉम्प्ट
प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें
\
\`List fraud networks for my Didit application through the Management API.
Endpoint:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/
Authentication:
Use the x-api-key header with my Didit API key.
Networks endpoints need a full-access API key: a key with restricted access gets 403.
Goal:
\- Retrieve the same clustered fraud networks the Console's Networks list shows: applicants, businesses, or transaction parties linked by shared device, IP, face, document number, phone, email, or address signals, within my own organization only.
Useful query params:
\- status=active,in_review,resolved,dismissed (comma-separated). Omit to exclude dismissed networks.
\- scope=identity|transactions: transactions keeps networks whose members are all transaction parties, identity keeps every other network. Omit for both. Any other value is a 400.
\- signal_type=ip_address,device,face,document_number,phone,email,address (comma-separated)
\- pattern_type=exact_same_device,similar_device,same_ip_address,same_address,similar_selfie_backgrounds,similar_poa_documents,same_document_number,same_phone_number,same_email (comma-separated)
\- risk_band=low,medium,high (comma-separated)
\- min_size, max_size - member count bounds
\- assignee=unassigned,,me (comma-separated, any value matches). me needs a console member token; an API key gets a 400.
\- priority=low,medium,high,none (comma-separated; none is a network without a priority). Any other value is a 400.
\- risk_min - minimum risk score, a whole number from 0 to 100. A value that is not a whole number is a 400.
\- has_case=true|false - networks your application opened a case for, or the others
\- date_from, date_to - ISO 8601 date/datetime bounds on activity
\- q - free-text search across network name, member names, and the network id (e.g. N-0001)
\- ordering=risk_score|-risk_score|last_activity_at|-last_activity_at|first_activity_at|-first_activity_at|network_number|-network_number (default -risk_score,-last_activity_at)
\- limit (1-500, default 100), offset
\- summary=true|false: false returns the page and its count only, without kpis and counts. Defaults to true. Any other value is a 400.
Example call:
curl -X GET "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/?status=active,in_review&ordering=-risk_score" \
-H "x-api-key: YOUR_API_KEY"
Response shape:
\{"count": int, "next": int|null, "previous": int|null, "results": [NetworkListItem, ...], "kpis": {...}, "counts": {...}, "sharing_mode": "off"|"private"|"global", "cross_org_available": bool, "cross_org_unavailable_reason": "plan"|"sharing_mode"|null}
next/previous are offsets, not URLs - null next means the last page.
Each NetworkListItem has uuid, network_id (e.g. "N-0001"), name, status (active|in_review|resolved|dismissed), risk {score, band, bar}, pattern_types, signal_types, member_counts, member_status, signal_coverage, first_activity_at, last_activity_at.
kpis carries active, in_review, applicants_involved, detected_this_period, false_positive_rate, each as {value, delta}, computed over the filtered result set.
counts carries scopes {all, identity, transactions}, views {all, active, in_review, resolved, dismissed, mine, high_risk} and facets {total, last_activity_days {"7", "30", "90"}, risk_min {"50", "80"}, signal_types {one count per signal type}, priority {low, medium, high, none}, assignee {me, unassigned, users: [{uuid, full_name, email, count}]}, has_case, min_size {"10"}}.
scopes count every network visible to this application; views count the visible networks inside the selected scope; facets count the networks in the selected scope and status view. The other filters do not change counts. mine and assignee.me are always 0 for an API key.
kpis and counts are omitted when summary=false.
Cross-organization fields (on every response, whatever summary says):
\- sharing_mode: the organization's cross-organization sharing mode. Only global compares networks across organizations; private and off keep them to the organization's own history.
\- cross_org_available: whether cross-organization signals apply to this organization. They need the Enterprise plan and the global sharing mode.
\- cross_org_unavailable_reason: plan (the organization's plan does not include the cross-organization fraud network; it needs the Enterprise plan, whatever the sharing mode), sharing_mode (the plan includes it, but sharing is private or off), or null when cross_org_available is true. plan is checked first.
Notes:
\- Sandbox applications never return networks - clustering excludes sandbox data entirely.
\- Networks are clustered organization-wide, but this endpoint only returns networks with at least one member visible to this application.
Failure modes:
\- 401: missing or invalid x-api-key. {"detail": "Authentication credentials were not provided or are invalid."}
\- 403: the API key belongs to another application, or it has restricted access (Networks needs a full-access key). A console member token needs list:networks. {"detail": "You do not have permission to perform this action."} or {"detail": "This API key has no access to this endpoint."}
\- 403 with code: Networks is not enabled for the organization. {"detail": "Networks is disabled for this organization. Contact Didit support if you believe this is an error.", "code": "networks_not_entitled"}
\- 400: an invalid filter, ordering, limit or offset, or summary that is not true or false. {"summary": ["Must be \\"true\\" or \\"false\\"."]}
Side effects: none, pure read.
For the full integration shape, see /integration/integration-prompt.`
\
यहाँ पेस्ट करें
आपके संगठन के लिए पहचाने गए धोखाधड़ी नेटवर्क की सूची लौटाता है। डिफ़ॉल्ट रूप से सूची जोखिम स्कोर के अनुसार क्रमबद्ध होती है, सबसे अधिक पहले, और फिर सबसे हालिया गतिविधि के अनुसार। कंसोल की नेटवर्क सूची में उपलब्ध हर फ़िल्टर एक क्वेरी पैरामीटर के रूप में उपलब्ध है, जिसमें मुक्त-टेक्स्ट `q` खोज और वही स्थिति, सिग्नल, पैटर्न और जोखिम-बैंड चिप्स शामिल हैं। `assignee`, `priority`, `risk_min` और `has_case` पैरामीटर उन असाइनी, प्राथमिकता, न्यूनतम जोखिम और जुड़े केस विकल्पों से मेल खाते हैं जिन्हें `counts.facets` गिनता है। `assignee=me` के लिए कंसोल सदस्य token चाहिए; API कुंजी के साथ यह `400` लौटाता है।> [!NOTE]
>
> सैंडबॉक्स एप्लिकेशन के पास कभी नेटवर्क नहीं होते। क्लस्टरिंग केवल प्रोडक्शन डेटा पर चलती है।## साझाकरण मोड और संगठनों के बीच सिग्नलहर रिस्पॉन्स में आपके संगठन का `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` आपके एप्लिकेशन को दिखने वाले हर नेटवर्क को एकत्र करता है, इसलिए दोनों की लागत केवल पेज की लागत से अधिक होती है।
केवल पेज और उसका `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 कुंजी](https://docs.didit.me/hi/console/api-keys.md) चाहिए।
प्रतिबंधित एक्सेस वाली कुंजी को `403` मिलता है।
कंसोल सदस्य token को `list:networks` चाहिए।
जब आपके संगठन के लिए Networks सक्षम नहीं होता, तो हर Networks एंडपॉइंट `"code": "networks_not_entitled"` के साथ `403` लौटाता है।## संबंधित- [नेटवर्क प्राप्त करें](https://docs.didit.me/hi/management-api/networks/get.md)
- [नेटवर्क ग्राफ़](https://docs.didit.me/hi/management-api/networks/graph.md)
- [नेटवर्क (कंसोल)](https://docs.didit.me/hi/console/networks.md)
## OpenAPI
````yaml hi/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/organization/{organization_id}/application/{application_id}/networks/:
get:
tags:
- Networks
summary: नेटवर्क सूचीबद्ध करें
description: >-
इस एप्लिकेशन के संगठन के भीतर पहचाने गए धोखाधड़ी नेटवर्क सूचीबद्ध करें,
डिफ़ॉल्ट रूप से उच्चतम जोखिम पहले। डिफ़ॉल्ट रूप से खारिज किए गए नेटवर्क
बाहर रखे जाते हैं; उन्हें शामिल करने के लिए status पास करें। सैंडबॉक्स
एप्लिकेशन में कभी भी नेटवर्क नहीं होते हैं: क्लस्टरिंग सैंडबॉक्स डेटा को
पूरी तरह से बाहर रखती है। प्रत्येक रिस्पॉन्स संगठन का `sharing_mode`
रखता है और यह भी कि क्या क्रॉस-संगठन सिग्नल इस पर लागू होते हैं
(`cross_org_available`, `cross_org_unavailable_reason`)। `kpis` आपके
फ़िल्टर से मेल खाने वाले नेटवर्क को एकत्रित करते हैं और `counts`
एप्लिकेशन द्वारा देखे जा सकने वाले प्रत्येक नेटवर्क को एकत्रित करते हैं;
जब आपको केवल पेज की आवश्यकता हो तो दोनों को छोड़ने के लिए
`summary=false` पास करें। इसके लिए पूर्ण-पहुँच API कुंजी, या कंसोल सदस्य
के लिए `list:networks` की आवश्यकता होती है।
operationId: list_networks
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: संगठन UUID।
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: एप्लिकेशन UUID।
- name: status
in: query
schema:
type: string
description: >-
शामिल करने के लिए स्थितियों की अल्पविराम से अलग की गई सूची:
active,in_review,resolved,dismissed। dismissed को बाहर करने के लिए
छोड़ दें।
- name: scope
in: query
schema:
type: string
enum:
- identity
- transactions
description: >-
`transactions` उन नेटवर्कों को रखता है जिनके सदस्य सभी लेन-देन पक्ष
हैं; `identity` अन्य प्रत्येक नेटवर्क को रखता है। दोनों के लिए छोड़
दें। यह `counts.views` और `counts.facets` को भी सीमित करता है। कोई
भी अन्य मान 400 लौटाता है।
- name: signal_type
in: query
schema:
type: string
description: >-
अल्पविराम से अलग किए गए सिग्नल प्रकार:
ip_address,device,face,document_number,phone,email,address।
- name: pattern_type
in: query
schema:
type: string
description: >-
अल्पविराम से अलग किए गए पैटर्न प्रकार, उदाहरण के लिए
exact_same_device,same_email।
- name: risk_band
in: query
schema:
type: string
description: 'कॉमा से अलग किए गए बैंड: low,medium,high।'
- name: min_size
in: query
schema:
type: integer
description: न्यूनतम सदस्य संख्या।
- name: max_size
in: query
schema:
type: integer
description: अधिकतम सदस्य संख्या।
- name: assignee
in: query
schema:
type: string
description: >-
कॉमा से अलग किए गए असाइनी: `unassigned`, सदस्य ईमेल (केस-असंवेदनशील
मिलान), या कॉलिंग कंसोल सदस्य के लिए `me`। एक नेटवर्क किसी भी मान से
मेल खाता है। `me` के लिए कंसोल सदस्य token आवश्यक है: API कुंजी को
400 `{"assignee": ["\"me\" needs a user token; an API key has no
assignee identity."]}` प्राप्त होता है।
- name: priority
in: query
schema:
type: string
description: >-
अल्पविराम से अलग की गई प्राथमिकताएँ: बिना किसी प्राथमिकता वाले
नेटवर्क के लिए `low`, `medium`, `high`, या `none`। कोई अन्य मान 400
`{"priority": "Unknown priority: ."}` लौटाता है।
- name: risk_min
in: query
schema:
type: integer
minimum: 0
maximum: 100
description: >-
न्यूनतम जोखिम स्कोर, 0 से 100 तक की एक पूर्ण संख्या। ऐसा मान जो
पूर्ण संख्या नहीं है, 400 `{"risk_min": "Use a whole number from 0
to 100."}` लौटाता है।
- name: has_case
in: query
schema:
type: boolean
description: >-
`true` उन नेटवर्क को रखता है जिनके लिए आपके एप्लिकेशन ने एक केस खोला
है, `false` दूसरों को रखता है। किसी भी अन्य मान को अनदेखा कर दिया
जाता है।
- name: date_from
in: query
schema:
type: string
format: date
description: last_activity_at पर निचली सीमा (ISO 8601 तिथि या दिनांक-समय)।
- name: date_to
in: query
schema:
type: string
format: date
description: first_activity_at पर ऊपरी सीमा (ISO 8601 दिनांक या डेटटाइम)।
- name: q
in: query
schema:
type: string
description: >-
नेटवर्क नाम, सदस्य नामों, network_id (N-0001), और सटीक pattern_type
टोकनों में मुक्त-पाठ खोज।
- name: ordering
in: query
schema:
type: string
description: >-
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 है।
- name: limit
in: query
schema:
type: integer
default: 100
minimum: 1
maximum: 500
description: पेज का आकार, 1-500। डिफ़ॉल्ट 100 है।
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
description: पहले रिकॉर्ड का शून्य-आधारित ऑफ़सेट।
- name: summary
in: query
schema:
type: boolean
default: true
description: >-
`false` केवल पेज और उसकी `count` लौटाता है, बिना `kpis` और `counts`
के। डिफ़ॉल्ट रूप से `true`। `true` या `false` के अलावा कोई भी मान
400 लौटाता है।
responses:
'200':
description: >-
पेजिनेटेड नेटवर्क सूची, संगठन के शेयरिंग मोड और क्रॉस-ऑर्गनाइज़ेशन
उपलब्धता के साथ, साथ ही `kpis` और `counts` जब तक कि `summary=false`
न हो।
content:
application/json:
schema:
type: object
properties:
count:
type: integer
next:
type: integer
nullable: true
description: अगले पेज का ऑफ़सेट, या अंतिम पेज पर null।
previous:
type: integer
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/NetworkListItem'
kpis:
type: object
description: >-
प्रत्येक कुंजी वर्तमान फ़िल्टर से मेल खाने वाले परिणामों
के लिए {value, delta} है। `summary=false` होने पर छोड़ दी
जाती है।
properties:
active:
type: object
in_review:
type: object
applicants_involved:
type: object
detected_this_period:
type: object
false_positive_rate:
type: object
counts:
$ref: '#/components/schemas/NetworkListCounts'
sharing_mode:
type: string
enum:
- 'off'
- private
- global
description: >-
संगठन का क्रॉस-संगठन शेयरिंग मोड। केवल `global` ही विभिन्न
संगठनों के नेटवर्क की तुलना करता है; `private` और `off`
उन्हें संगठन के अपने इतिहास तक ही सीमित रखते हैं।
example: global
cross_org_available:
type: boolean
description: >-
क्या क्रॉस-संगठन संकेत इस संगठन पर लागू होते हैं। उन्हें
Enterprise प्लान और `global` शेयरिंग मोड दोनों की आवश्यकता
होती है।
example: true
cross_org_unavailable_reason:
type: string
enum:
- plan
- sharing_mode
nullable: true
description: >-
क्रॉस-ऑर्गेनाइज़ेशन सिग्नल क्यों लागू नहीं होते, इस क्रम
में जाँचे जाते हैं। `plan`: संगठन के प्लान में
क्रॉस-ऑर्गेनाइज़ेशन फ़्रॉड नेटवर्क शामिल नहीं है (इसके लिए
Enterprise प्लान की आवश्यकता है), भले ही शेयरिंग मोड कुछ
भी हो। `sharing_mode`: प्लान में यह शामिल है, लेकिन
शेयरिंग मोड `private` या `off` है। `cross_org_available`
के `true` होने पर Null।
example: null
required:
- count
- next
- previous
- results
- sharing_mode
- cross_org_available
- cross_org_unavailable_reason
'400':
description: एक अमान्य फ़िल्टर, क्रमबद्धता, पेजिनेशन या `summary` मान।
content:
application/json:
examples:
Invalid summary:
summary: अमान्य सारांश
value:
summary:
- Must be "true" or "false".
Invalid scope:
summary: अमान्य स्कोप
value:
scope:
- Use identity or transactions.
Unsupported ordering:
summary: असमर्थित क्रमबद्धता
value:
- Unsupported ordering.
'401':
description: अनुपलब्ध या अमान्य क्रेडेंशियल।
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
कोडित त्रुटियों पर मौजूद, उदाहरण के लिए
`networks_not_entitled`।
examples:
Missing or invalid credentials:
summary: अनुपलब्ध या अमान्य क्रेडेंशियल
value:
detail: >-
Authentication credentials were not provided or are
invalid.
'403':
description: >-
API कुंजी किसी अन्य एप्लिकेशन से संबंधित है, या यह प्रतिबंधित एक्सेस
वाली कुंजी है: Networks endpoints के लिए पूर्ण-एक्सेस कुंजी की
आवश्यकता होती है। कंसोल सदस्य token के लिए `list:networks` आवश्यक
है। जब संगठन के लिए Networks सक्षम नहीं होता है, तो `code:
networks_not_entitled` के साथ भी लौटाया जाता है।
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
कोडित त्रुटियों पर मौजूद, उदाहरण के लिए
`networks_not_entitled`।
examples:
Networks not enabled:
summary: नेटवर्क सक्षम नहीं हैं
value:
detail: >-
Networks is disabled for this organization. Contact Didit
support if you believe this is an error.
code: networks_not_entitled
Restricted API key:
summary: प्रतिबंधित API कुंजी
value:
detail: This API key has no access to this endpoint.
No permission:
summary: कोई अनुमति नहीं
value:
detail: You do not have permission to perform this action.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: curl
source: >-
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'
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
client = Didit()
for item in client.networks.list():
print(item)
- lang: javascript
label: Node.js
source: |-
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);
}
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\niter := client.Networks.ListAutoPaging(ctx, didit.NetworksListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
- lang: java
label: Java
source: |-
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);
}
- lang: php
label: PHP
source: |-
networks->list() as $item) {
print_r($item->toArray());
}
- lang: ruby
label: Ruby
source: |-
require "didit"
# Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
# and DIDIT_APPLICATION_ID.
didit = Didit::Client.new
didit.networks.list.auto_paging_each do |item|
puts item.to_h
end
- lang: csharp
label: .NET
source: |-
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));
}
components:
schemas:
NetworkListItem:
type: object
properties:
uuid:
type: string
format: uuid
network_id:
type: string
description: मानव-पठनीय प्रति-संगठन अनुक्रमिक id, उदाहरण के लिए N-0001।
name:
type: string
nullable: true
status:
type: string
enum:
- active
- in_review
- resolved
- dismissed
description: >-
नेटवर्क लाइफ़साइकल स्थिति। किसी नेटवर्क के अंदर प्रति-आवेदक
outcome_status (approved/in_review/declined/not_completed) से अलग।
risk:
$ref: '#/components/schemas/NetworkRiskDisplay'
pattern_types:
type: array
items:
type: string
enum:
- exact_same_device
- similar_device
- same_ip_address
- same_address
- similar_selfie_backgrounds
- similar_poa_documents
- same_document_number
- same_phone_number
- same_email
description: इस नेटवर्क में पाए गए क्लस्टरिंग पैटर्न।
signal_types:
type: array
items:
type: string
enum:
- ip_address
- device
- face
- document_number
- phone
- email
- address
description: इस नेटवर्क में मौजूद विशिष्ट सिग्नल प्रकार।
member_counts:
type: object
description: श्रेणी के अनुसार सदस्यों की संख्या (उदा. कुल, प्रति outcome_status)।
member_status:
type: object
description: outcome_status के अनुसार सदस्यों का विवरण।
signal_coverage:
type: object
description: इस नेटवर्क के सदस्यों का प्रति signal_type कवरेज।
first_activity_at:
type: string
format: date-time
nullable: true
last_activity_at:
type: string
format: date-time
nullable: true
NetworkListCounts:
type: object
description: >-
सूची के दृश्यों और फ़िल्टर विकल्पों के लिए नेटवर्क संख्या, प्रत्येक
नेटवर्क की एक बार गणना की गई है। केवल तभी लौटाया जाता है जब `summary`
`false` न हो। `scopes` एप्लिकेशन को दिखाई देने वाले प्रत्येक नेटवर्क की
गणना करता है। `views` चयनित `scope` के अंदर दिखाई देने वाले नेटवर्क की
गणना करता है। `facets` चयनित `scope` और `status` दृश्य में नेटवर्क की
गणना करता है (खारिज किए गए नेटवर्क तब तक छोड़ दिए जाते हैं जब तक कि
`status` में वे शामिल न हों)। अन्य सूची फ़िल्टर इन गणनाओं को नहीं बदलते
हैं।
properties:
scopes:
type: object
description: उत्पाद के अनुसार दृश्यमान नेटवर्क।
properties:
all:
type: integer
identity:
type: integer
description: प्रत्येक अन्य नेटवर्क।
transactions:
type: integer
description: वे नेटवर्क जिनके सदस्य सभी लेन-देन पक्ष हैं।
views:
type: object
description: >-
चयनित `scope` के अंदर दृश्यमान नेटवर्क, स्थिति के अनुसार, साथ ही दो
सहेजे गए दृश्य।
properties:
all:
type: integer
active:
type: integer
in_review:
type: integer
resolved:
type: integer
dismissed:
type: integer
mine:
type: integer
description: >-
कॉल करने वाले कंसोल सदस्य को असाइन किए गए नेटवर्क। API कुंजी के
लिए हमेशा 0।
high_risk:
type: integer
description: >-
80 या उससे अधिक के जोखिम स्कोर वाले नेटवर्क जो खारिज नहीं किए गए
हैं।
facets:
type: object
description: >-
चयनित `scope` और स्थिति दृश्य में, प्रत्येक फ़िल्टर विकल्प के लिए
संख्या।
properties:
total:
type: integer
description: चयनित `scope` और स्थिति दृश्य में नेटवर्क।
last_activity_days:
type: object
description: >-
पिछले 7, 30 और 90 दिनों में गतिविधि वाले नेटवर्क, दिनों की
संख्या द्वारा कुंजीबद्ध।
properties:
'7':
type: integer
'30':
type: integer
'90':
type: integer
risk_min:
type: object
description: >-
कम से कम 50 और कम से कम 80 के जोखिम स्कोर वाले नेटवर्क,
थ्रेशोल्ड द्वारा कुंजीबद्ध।
properties:
'50':
type: integer
'80':
type: integer
signal_types:
type: object
description: प्रत्येक प्रकार के कम से कम एक सिग्नल वाले नेटवर्क।
properties:
ip_address:
type: integer
device:
type: integer
face:
type: integer
document_number:
type: integer
phone:
type: integer
email:
type: integer
address:
type: integer
priority:
type: object
description: >-
प्राथमिकता के आधार पर नेटवर्क। `none` बिना प्राथमिकता वाले
नेटवर्क की गणना करता है।
properties:
low:
type: integer
medium:
type: integer
high:
type: integer
none:
type: integer
assignee:
type: object
description: असाइनी के अनुसार नेटवर्क।
properties:
me:
type: integer
description: >-
कॉल करने वाले कंसोल सदस्य को असाइन किया गया। API कुंजी के
लिए हमेशा 0 होता है।
unassigned:
type: integer
description: किसी को असाइन नहीं किया गया।
users:
type: array
description: >-
प्रत्येक असाइनी के लिए एक प्रविष्टि, सबसे अधिक नेटवर्क वाले
पहले।
items:
type: object
properties:
uuid:
type: string
format: uuid
full_name:
type: string
description: असाइनी का नाम, या कोई नाम सेट न होने पर उनका ईमेल।
email:
type: string
count:
type: integer
has_case:
type: integer
description: वे नेटवर्क जिनके लिए इस एप्लिकेशन ने केस खोला है।
min_size:
type: object
description: कम से कम 10 सदस्यों वाले नेटवर्क, न्यूनतम आकार द्वारा कुंजीबद्ध।
properties:
'10':
type: integer
NetworkRiskDisplay:
type: object
properties:
score:
type: integer
description: जोखिम स्कोर, 0-100।
band:
type: string
enum:
- low
- medium
- high
description: >-
बैंड जिसके रूप में स्कोर रेंडर होता है। high >= 70, medium >= 40,
अन्यथा low।
bar:
type: number
format: float
description: जोखिम बार रेंडर करने के लिए सामान्यीकृत 0-1 मान।
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys
से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप
किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या
स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक
सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी
समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी,
कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP
सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी
के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को
छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write
के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं।
देखें https://docs.didit.me/console/api-keys।
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.