> ## 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.
# Betrugsnetzwerke auflisten (List Networks API)
> Listet mit Didit erkannte Betrugsnetzwerke auf, filterbar nach Status, Signal, Muster, Risikostufe, Größe, Datum; mit Freigabemodus und Listenzahlen.
Prompt zur List-Networks-API
Prompt in die Zwischenablage kopieren
\
\`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.`
\
Einfügen in
Listet die für Ihre Organisation erkannten Betrugsnetzwerke auf.
Standardmäßig ist die Liste nach dem Risiko-Score sortiert, wobei der höchste Wert zuerst kommt, dann nach der jüngsten Aktivität.
Jeder Filter, der in der Netzwerkliste der Console verfügbar ist, steht als Query-Parameter zur Verfügung, einschließlich der Freitextsuche über `q` und derselben Status-, Signal-, Muster- und Risikostufen-Chips.
Die Parameter `assignee`, `priority`, `risk_min` und `has_case` entsprechen den Optionen Zuständiger, Priorität, Mindestrisiko und verknüpfter Fall, die `counts.facets` zählt.
`assignee=me` erfordert ein Token eines Console-Mitglieds; mit einem API-Schlüssel liefert es `400`.> [!NOTE]
>
> Sandbox-Anwendungen haben nie Netzwerke. Die Clusterbildung läuft ausschließlich mit Produktionsdaten.## Freigabemodus und organisationsübergreifende SignaleJede Antwort enthält den `sharing_mode`, `cross_org_available` und `cross_org_unavailable_reason` Ihrer Organisation.| Feld | Bedeutung |
| - | - |
| `sharing_mode` | Der Freigabemodus für organisationsübergreifende Daten Ihrer Organisation. Nur `global` vergleicht Netzwerke über Organisationen hinweg; `private` und `off` beschränken sie auf den eigenen Verlauf der Organisation. |
| `cross_org_available` | Ob organisationsübergreifende Signale für Ihre Organisation gelten. Dafür sind sowohl der Enterprise-Tarif als auch der Freigabemodus `global` nötig. |
| `cross_org_unavailable_reason` | `plan`, wenn Ihr Tarif das organisationsübergreifende Betrugsnetzwerk nicht enthält (dafür ist der Enterprise-Tarif nötig), unabhängig von Ihrem Freigabemodus. `sharing_mode`, wenn der Tarif es enthält, Ihr Freigabemodus aber `private` oder `off` ist. `null`, wenn `cross_org_available` den Wert `true` hat. |Der Tarif wird zuerst geprüft: Unterhalb des Enterprise-Tarifs ist der Grund `plan`, auch wenn Ihr Freigabemodus `global` ist.## Zähler und der Parameter summary`kpis` aggregiert die Netzwerke, die Ihren Filtern entsprechen, und `counts` aggregiert jedes Netzwerk, das Ihre Anwendung sehen kann. Beide sind aufwendiger als die Seite selbst.
Übergeben Sie `summary=false`, wenn Sie nur die Seite und ihren `count` benötigen: Die Antwort enthält dann weder `kpis` noch `counts`.
`summary` akzeptiert nur `true` oder `false`; jeder andere Wert liefert `400`.`counts` enthält die Zahlen hinter den Ansichten und Filteroptionen der Liste, wobei jedes Netzwerk genau einmal gezählt wird:| Schlüssel | Was gezählt wird |
| - | - |
| `scopes` | Jedes sichtbare Netzwerk (`all`), aufgeteilt in `transactions` (jedes Mitglied ist eine Transaktionspartei) und `identity` (jedes andere Netzwerk). |
| `views` | Sichtbare Netzwerke innerhalb des ausgewählten `scope` (`all`), nach Status (`active`, `in_review`, `resolved`, `dismissed`), dem aufrufenden Console-Mitglied zugewiesen (`mine`) sowie `high_risk` (Risiko-Score von 80 oder mehr, nicht verworfen). |
| `facets` | Netzwerke im ausgewählten `scope` und in der ausgewählten `status`-Ansicht (`total`), nach letzter Aktivität (`last_activity_days`: 7, 30, 90), Mindestrisiko (`risk_min`: 50, 80), Signaltyp, Priorität (einschließlich `none`), Zuständigem (`me`, `unassigned` und ein Eintrag pro Zuständigem in `users`), Netzwerken, für die Ihre Anwendung einen Fall geöffnet hat (`has_case`), und Netzwerken mit mindestens 10 Mitgliedern (`min_size`). |Andere Filter als `scope` und `status` ändern `counts` nicht.
`views.mine` und `facets.assignee.me` sind bei einem API-Schlüssel immer `0`, da kein Console-Mitglied den Aufruf tätigt.## ZugriffNetzwerk-Endpoints erfordern einen [API-Schlüssel](https://docs.didit.me/de/console/api-keys.md) mit vollem Zugriff.
Ein Schlüssel mit eingeschränktem Zugriff erhält `403`.
Ein Token eines Console-Mitglieds benötigt `list:networks`.
Wenn Networks für Ihre Organisation nicht aktiviert ist, liefert jeder Networks-Endpoint `403` mit `"code": "networks_not_entitled"`.## Verwandte Seiten- [Netzwerk abrufen](https://docs.didit.me/de/management-api/networks/get.md)
- [Netzwerkgraph](https://docs.didit.me/de/management-api/networks/graph.md)
- [Netzwerke (Console)](https://docs.didit.me/de/console/networks.md)
## OpenAPI
````yaml de/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 für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/organization/{organization_id}/application/{application_id}/networks/:
get:
tags:
- Networks
summary: Netzwerke auflisten
description: >-
Listet Betrugsnetzwerke auf, die innerhalb der Organisation dieser
Anwendung erkannt wurden, standardmäßig mit dem höchsten Risiko zuerst.
Standardmäßig sind verworfene Netzwerke ausgeschlossen; übergeben Sie
status, um sie einzuschließen. Sandbox-Anwendungen haben niemals
Netzwerke: Clustering schließt Sandbox-Daten vollständig aus. Jede
Antwort enthält den `sharing_mode` der Organisation und die Angabe, ob
organisationsübergreifende Signale darauf zutreffen
(`cross_org_available`, `cross_org_unavailable_reason`). `kpis`
aggregieren die Netzwerke, die Ihren Filtern entsprechen, und `counts`
aggregieren jedes Netzwerk, das die Anwendung sehen kann; übergeben Sie
`summary=false`, um beides zu überspringen, wenn Sie nur die Seite
benötigen. Erfordert einen API-Schlüssel mit Vollzugriff oder
`list:networks` für ein Mitglied der Konsole.
operationId: list_networks
parameters:
- name: organization_id
in: path
required: true
schema:
type: string
format: uuid
description: UUID der Organisation.
- name: application_id
in: path
required: true
schema:
type: string
format: uuid
description: Anwendungs-UUID.
- name: status
in: query
schema:
type: string
description: >-
Kommagetrennte Liste der einzuschließenden Status:
active,in_review,resolved,dismissed. Weglassen, um verworfene
auszuschließen.
- name: scope
in: query
schema:
type: string
enum:
- identity
- transactions
description: >-
`transactions` behält Netzwerke bei, deren Mitglieder ausnahmslos
Transaktionsparteien sind; `identity` behält jedes andere Netzwerk
bei. Weglassen für beide. Dies schränkt auch `counts.views` und
`counts.facets` ein. Jeder andere Wert gibt 400 zurück.
- name: signal_type
in: query
schema:
type: string
description: >-
Kommagetrennte Signaltypen:
ip_address,device,face,document_number,phone,email,address.
- name: pattern_type
in: query
schema:
type: string
description: Kommagetrennte Mustertypen, z. B. exact_same_device,same_email.
- name: risk_band
in: query
schema:
type: string
description: 'Kommagetrennte Bänder: low,medium,high.'
- name: min_size
in: query
schema:
type: integer
description: Mindestanzahl an Mitgliedern.
- name: max_size
in: query
schema:
type: integer
description: Maximale Mitgliederanzahl.
- name: assignee
in: query
schema:
type: string
description: >-
Kommagetrennte Zuständige: `unassigned`, E-Mail-Adressen von
Mitgliedern (ohne Berücksichtigung der Groß-/Kleinschreibung) oder
`me` für das aufrufende Konsolenmitglied. Ein Netzwerk stimmt mit
jedem Wert überein. `me` erfordert ein Token für Konsolenmitglieder:
Ein API-Schlüssel erhält 400 `{"assignee": ["\"me\" needs a user
token; an API key has no assignee identity."]}`.
- name: priority
in: query
schema:
type: string
description: >-
Kommagetrennte Prioritäten: `low`, `medium`, `high` oder `none` für
Netzwerke ohne Priorität. Jeder andere Wert gibt 400 `{"priority":
"Unknown priority: ."}` zurück.
- name: risk_min
in: query
schema:
type: integer
minimum: 0
maximum: 100
description: >-
Minimaler Risiko-Score, eine ganze Zahl von 0 bis 100. Ein Wert, der
keine ganze Zahl ist, gibt 400 `{"risk_min": "Use a whole number
from 0 to 100."}` zurück.
- name: has_case
in: query
schema:
type: boolean
description: >-
`true` behält die Netzwerke bei, für die Ihre Anwendung einen Fall
eröffnet hat, `false` die übrigen. Jeder andere Wert wird ignoriert.
- name: date_from
in: query
schema:
type: string
format: date
description: >-
Untergrenze für last_activity_at (ISO-8601-Datum oder
-Datum/Uhrzeit).
- name: date_to
in: query
schema:
type: string
format: date
description: Obere Grenze für first_activity_at (ISO 8601-Datum oder -Datetime).
- name: q
in: query
schema:
type: string
description: >-
Freitextsuche nach Netzwerknamen, Mitgliedernamen, der network_id
(N-0001) und exakten pattern_type-Tokens.
- name: ordering
in: query
schema:
type: string
description: >-
Einer der Werte risk_score, -risk_score, last_activity_at,
-last_activity_at, first_activity_at, -first_activity_at,
network_number, -network_number. Standardwert ist
-risk_score,-last_activity_at.
- name: limit
in: query
schema:
type: integer
default: 100
minimum: 1
maximum: 500
description: Seitengröße, 1-500. Standardmäßig 100.
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
description: Nullbasierter Offset des ersten Datensatzes.
- name: summary
in: query
schema:
type: boolean
default: true
description: >-
`false` gibt nur die Seite und deren `count` zurück, ohne `kpis` und
`counts`. Standardmäßig `true`. Jeder andere Wert als `true` oder
`false` gibt 400 zurück.
responses:
'200':
description: >-
Paginierte Netzwerkliste mit dem Freigabemodus der Organisation und
der organisationsübergreifenden Verfügbarkeit, plus `kpis` und
`counts`, sofern nicht `summary=false`.
content:
application/json:
schema:
type: object
properties:
count:
type: integer
next:
type: integer
nullable: true
description: Offset der nächsten Seite oder null auf der letzten Seite.
previous:
type: integer
nullable: true
results:
type: array
items:
$ref: '#/components/schemas/NetworkListItem'
kpis:
type: object
description: >-
Jeder Schlüssel enthält {value, delta} für die Ergebnisse,
die den aktuellen Filtern entsprechen. Wird weggelassen,
wenn `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: >-
Der organisationsübergreifende Freigabemodus der
Organisation. Nur `global` vergleicht Netzwerke über
Organisationen hinweg; `private` und `off` beschränken sie
auf den eigenen Verlauf der Organisation.
example: global
cross_org_available:
type: boolean
description: >-
Gibt an, ob organisationsübergreifende Signale für diese
Organisation gelten. Sie erfordern sowohl den
Enterprise-Tarif als auch den Freigabemodus `global`.
example: true
cross_org_unavailable_reason:
type: string
enum:
- plan
- sharing_mode
nullable: true
description: >-
Warum organisationsübergreifende Signale nicht greifen,
geprüft in dieser Reihenfolge. `plan`: Der Tarif der
Organisation enthält das organisationsübergreifende
Betrugsnetzwerk nicht (erfordert den Enterprise-Tarif),
unabhängig vom Freigabemodus. `sharing_mode`: Der Tarif
enthält es, aber der Freigabemodus ist `private` oder
`off`. Null, wenn `cross_org_available` `true` ist.
example: null
required:
- count
- next
- previous
- results
- sharing_mode
- cross_org_available
- cross_org_unavailable_reason
'400':
description: Ein ungültiger Filter-, Sortier-, Paginierungs- oder `summary`-Wert.
content:
application/json:
examples:
Invalid summary:
summary: Ungültige Zusammenfassung
value:
summary:
- Must be "true" or "false".
Invalid scope:
summary: Ungültiger Scope
value:
scope:
- Use identity or transactions.
Unsupported ordering:
summary: Nicht unterstützte Sortierung
value:
- Unsupported ordering.
'401':
description: Fehlende oder ungültige Anmeldedaten.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
Vorhanden bei codierten Fehlern, zum Beispiel
`networks_not_entitled`.
examples:
Missing or invalid credentials:
summary: Fehlende oder ungültige Anmeldedaten
value:
detail: >-
Authentication credentials were not provided or are
invalid.
'403':
description: >-
Der API-Schlüssel gehört zu einer anderen Anwendung oder ist ein
Schlüssel mit eingeschränktem Zugriff: Networks-Endpoints erfordern
einen Schlüssel mit Vollzugriff. Ein Konsolen-Mitgliedstoken
benötigt `list:networks`. Wird auch mit `code:
networks_not_entitled` zurückgegeben, wenn Networks für die
Organisation nicht aktiviert ist.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
code:
type: string
description: >-
Vorhanden bei codierten Fehlern, zum Beispiel
`networks_not_entitled`.
examples:
Networks not enabled:
summary: Netzwerke nicht aktiviert
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: Eingeschränkter API-Schlüssel
value:
detail: This API key has no access to this endpoint.
No permission:
summary: Keine Berechtigung
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: >-
Für Menschen lesbare, fortlaufende ID pro Organisation, z. B.
N-0001.
name:
type: string
nullable: true
status:
type: string
enum:
- active
- in_review
- resolved
- dismissed
description: >-
Lebenszyklusstatus des Netzwerks. Unterscheidet sich vom
antragstellerspezifischen outcome_status innerhalb eines Netzwerks
(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: Die in diesem Netzwerk erkannten Clustering-Muster.
signal_types:
type: array
items:
type: string
enum:
- ip_address
- device
- face
- document_number
- phone
- email
- address
description: >-
Die unterschiedlichen Signaltypen, die in diesem Netzwerk vorhanden
sind.
member_counts:
type: object
description: >-
Anzahl der Mitglieder nach Kategorie (z. B. insgesamt, pro
outcome_status).
member_status:
type: object
description: Aufschlüsselung der Mitglieder nach outcome_status.
signal_coverage:
type: object
description: Abdeckung der Mitglieder dieses Netzwerks pro 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: >-
Netzwerkanzahlen für die Ansichten und Filteroptionen der Liste, wobei
jedes Netzwerk einmal gezählt wird. Wird nur zurückgegeben, wenn
`summary` nicht `false` ist. `scopes` zählt jedes für die Anwendung
sichtbare Netzwerk. `views` zählt die sichtbaren Netzwerke innerhalb des
ausgewählten `scope`. `facets` zählt die Netzwerke im ausgewählten
`scope` und der `status`-Ansicht (verworfene Netzwerke werden
ausgelassen, es sei denn, `status` enthält sie). Die anderen
Listenfilter ändern diese Anzahlen nicht.
properties:
scopes:
type: object
description: Sichtbare Netzwerke nach Produkt.
properties:
all:
type: integer
identity:
type: integer
description: Jedes andere Netzwerk.
transactions:
type: integer
description: Netzwerke, deren Mitglieder alle Transaktionsparteien sind.
views:
type: object
description: >-
Sichtbare Netzwerke innerhalb des ausgewählten `scope`, nach Status,
plus zwei gespeicherte Ansichten.
properties:
all:
type: integer
active:
type: integer
in_review:
type: integer
resolved:
type: integer
dismissed:
type: integer
mine:
type: integer
description: >-
Netzwerke, die dem aufrufenden Console-Mitglied zugewiesen sind.
Bei einem API-Schlüssel immer 0.
high_risk:
type: integer
description: >-
Netzwerke mit einem Risiko-Score von mindestens 80, die nicht
verworfen wurden.
facets:
type: object
description: >-
Anzahlen für jede Filteroption innerhalb des ausgewählten `scope`
und der Statusansicht.
properties:
total:
type: integer
description: Netzwerke im ausgewählten `scope` und der Statusansicht.
last_activity_days:
type: object
description: >-
Netzwerke mit Aktivität in den letzten 7, 30 und 90 Tagen,
aufgeschlüsselt nach der Anzahl der Tage.
properties:
'7':
type: integer
'30':
type: integer
'90':
type: integer
risk_min:
type: object
description: >-
Netzwerke mit einem Risiko-Score von mindestens 50 und
mindestens 80, aufgeschlüsselt nach dem Schwellenwert.
properties:
'50':
type: integer
'80':
type: integer
signal_types:
type: object
description: Netzwerke mit mindestens einem Signal jedes Typs.
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: Netzwerke nach Priorität. `none` zählt Netzwerke ohne Priorität.
properties:
low:
type: integer
medium:
type: integer
high:
type: integer
none:
type: integer
assignee:
type: object
description: Netzwerke nach zugewiesener Person.
properties:
me:
type: integer
description: >-
Dem aufrufenden Console-Mitglied zugewiesen. Bei einem
API-Schlüssel immer 0.
unassigned:
type: integer
description: Niemandem zugewiesen.
users:
type: array
description: >-
Ein Eintrag pro Beauftragtem, diejenigen mit den meisten
Netzwerken zuerst.
items:
type: object
properties:
uuid:
type: string
format: uuid
full_name:
type: string
description: >-
Der Name der zugewiesenen Person oder deren
E-Mail-Adresse, wenn kein Name festgelegt ist.
email:
type: string
count:
type: integer
has_case:
type: integer
description: Netzwerke, für die diese Anwendung einen Fall eröffnet hat.
min_size:
type: object
description: >-
Netzwerke mit mindestens 10 Mitgliedern, aufgeschlüsselt nach
der Mindestgröße.
properties:
'10':
type: integer
NetworkRiskDisplay:
type: object
properties:
score:
type: integer
description: Risiko-Score, 0-100.
band:
type: string
enum:
- low
- medium
- high
description: >-
Bereich, in dem der Score dargestellt wird. high >= 70, medium >=
40, andernfalls low.
bar:
type: number
format: float
description: Normalisierter Wert von 0–1 zur Darstellung eines Risikobalkens.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
null. Siehe https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.