> ## 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.

# Betrugsnetzwerk-Timeline API

> Didit: Ereignisverlauf eines Betrugsnetzwerks abrufen, mit contract=2 paginierte Timeline mit Versuchen, Transaktionen, Anmeldungen, Regeltreffern.



Prompt für die Netzwerk-Timeline-API
        Prompt in die Zwischenablage kopieren



      
      

\<pre>

\`Retrieve a fraud network's event timeline through the Management API.

Endpoint:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/

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.

Path parameter:
\- network_uuid - the network's UUID.

Two shapes, chosen by the contract query parameter:

1\. Default (no contract parameter): unchanged.
Response 200: {"results": [NetworkTimelineEvent, ...]}, oldest first, not paginated.
Each event has event_type (network_detected, signal_observed, network_active, network_in_review, network_resolved, network_dismissed), occurred_at, label, and metadata (event-specific, e.g. {network_id} for detection, {signal_type, subject_count, is_hub} for a signal observation, {reason} for a status change).
limit, cursor and event_type are ignored in this mode.

2\. Typed timeline (contract=2, opt-in):
Query params:
\- contract=2: required for this mode. Any other value is a 400.
\- limit: 1 to 500, default 100.
\- cursor: the previous page's next_cursor. An invalid or empty cursor is a 400 ("This cursor is not valid. Reload the feed.").
\- event_type: repeat it or pass a comma-separated list, at most 20 values. Defaults to every type: network_detected, signal_observed, network_active, network_in_review, network_resolved, network_dismissed, verification_attempt, transaction, login, rule_hit, case_linked, note_added.
Response 200: {"results": [NetworkTypedTimelineEvent, ...], "next_cursor": string|null}, newest first. Keep calling with cursor=next_cursor until next_cursor is null.
Each typed event has:
\- event_type, occurred_at, label, metadata: as in the default shape (metadata is {} for events that are not the network's own).
\- id: "<source>:<uuid>", unique within the timeline. ingested_at: when Didit stored it.
\- account: the member account {node_id ("vendor_user:<uuid>", "vendor_business:<uuid>" or "transaction_party:<uuid>"), node_type (account|business_account|transaction_party), uuid, vendor_data, display_name, ownership (owned|organization), route {kind, id, application_id}}. Null for the network's own events, case_linked and note_added.
\- source_ref: the record it was read from {kind (session|business_session|transaction|monitoring_event|case), id, ownership, route}. route is absent for monitoring_event and case. Null for the network's own events and note_added.
\- ownership: owned when the record belongs to the application I called, organization when it belongs to another application of my organization.
\- One detail block per event type, the others null:
\- verification_attempt {session_id, session_number, attempt, attempt_count, status, status_changed_at, decline_reasons [{risk, feature, short_description}] (declined sessions only)}
\- transaction {transaction_id, transaction_number, transaction_type, action_type, amount {value, currency, direction} or null, status, decision_reason_code, decision_reason_label, party_role}
\- login {action (auth.login, security.login_succeeded, auth.login_failed or security.login_failed), succeeded, status, ip {address, country_code, city, connection_type (free text), is_vpn_or_tor, is_data_center} or null, device {fingerprint, label} or null, is_first_login, is_new_device}
\- rule_hit {rule_id, rule_title, rule_category, rule_source, severity, score_delta, status_target, action_summary}
\- case_linked {case_id, case_number, status, author_email, author_name}
\- note_added {note_id, author_email}: never returned to an API key, only to console members.

Example call:
curl -X GET "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/?contract=2&limit=50&event_type=verification_attempt,login" \
-H "x-api-key: YOUR_API_KEY"

Failure modes:
\- 400 (contract mode only): {"contract": [...]}, {"limit": [...]}, {"cursor": ["This cursor is not valid. Reload the feed."]} or {"event_type": {...}}.
\- 404: {"detail": "Network not found."}. The network does not exist, or has no member visible to this application.
\- 401: missing or invalid x-api-key.
\- 403: the API key belongs to another application, or it has restricted access (Networks needs a full-access key). A console member token needs read:networks.
\- 403 with {"code": "networks_not_entitled"}: Networks is not enabled for the organization.

Side effects: none, pure read.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

Einfügen in

Rufen Sie den Ereignisverlauf eines Netzwerks ab.
Ohne `contract` ist die Antwort der eigene Verlauf des Netzwerks, der älteste Eintrag zuerst und nicht paginiert: wann es erstmals erkannt wurde, wann jedes Signal zuletzt beobachtet wurde und seine letzte Statusänderung mit dem Grund.
Dieses Format ist unverändert, und `limit`, `cursor` und `event_type` werden ignoriert.## Typisierte TimelineÜbergeben Sie `contract=2`, um stattdessen die typisierte Timeline abzurufen.
Sie enthält zusätzlich, was die Mitgliedskonten getan haben und was Ihr Team in Bezug auf das Netzwerk unternommen hat, der neueste Eintrag zuerst, seitenweise.
`contract` akzeptiert nur `2`; jeder andere Wert gibt `400` zurück.| Parameter | Bedeutung |
| - | - |
| `limit` | Ereignisse pro Seite, 1 bis 500. Standardwert ist 100. |
| `cursor` | Der `next_cursor` der vorherigen Seite. Ein ungültiger oder leerer Cursor gibt `400` zurück. |
| `event_type` | Die beizubehaltenden Ereignistypen, wiederholt oder kommagetrennt, höchstens 20 Werte. Standardmäßig werden alle Typen zurückgegeben. |Die Antwort lautet `{"results": [...], "next_cursor": "..."}`.
Rufen Sie die nächste Seite ab, indem Sie `cursor` auf `next_cursor` setzen, bis `next_cursor` den Wert `null` hat.## Ereignistypen| `event_type` | Was sie erfasst | Detailblock |
| - | - | - |
| `network_detected` | Das Netzwerk wurde erkannt | Keiner |
| `signal_observed` | Die letzte Beobachtung eines Signals | Keiner |
| `network_active`, `network_in_review`, `network_resolved`, `network_dismissed` | Die letzte Statusänderung des Netzwerks mit dem Grund in `metadata` | Keiner |
| `verification_attempt` | Eine Verifizierungssitzung eines Mitglieds (einer Person oder eines Unternehmens), nummeriert (`attempt` von `attempt_count`), mit den Ablehnungsgründen, wenn sie abgelehnt wurde | `verification_attempt` |
| `transaction` | Eine Transaktion, an der ein Mitglied beteiligt war, datiert nach ihrem Transaktionsdatum | `transaction` |
| `login` | Eine Anmeldung oder fehlgeschlagene Anmeldung, die Sie für ein Mitglied über die [Ereignis-API](https://docs.didit.me/de/transaction-monitoring/events.md) übermittelt haben | `login` |
| `rule_hit` | Eine aktive Regel, die auf eine Transaktion oder ein Ereignis eines Mitglieds zutraf | `rule_hit` |
| `case_linked` | Ein Fall, der für das Netzwerk in Ihrer Organisation eröffnet wurde | `case_linked` |
| `note_added` | Eine Notiz zum Netzwerk, ohne deren Text | `note_added` |`note_added`-Ereignisse werden nur Mitgliedern der Konsole zurückgegeben, niemals einem API-Schlüssel.
Eine Transaktion zwischen zwei Mitgliedern erscheint für jedes von ihnen einmal, jeweils mit eigenem `account`.
Ein Regel-Treffer auf diese Transaktion erscheint einmal.
Login-Ereignisse gibt es nur für die Anmeldungen, die Sie als Ereignisse übermitteln: `auth.login`, `security.login_succeeded` und deren fehlgeschlagene Formen.## Konten und DatensätzeJedes Mitgliedsereignis enthält `account`, das zugehörige Mitglied, sowie `source_ref`, die Sitzung, Unternehmenssitzung, Transaktion, das Monitoring-Ereignis oder den Fall, aus dem das Ereignis gelesen wurde.
`ownership` ist `owned`, wenn der Datensatz zur aufgerufenen Anwendung gehört, und `organization`, wenn er zu einer anderen Anwendung Ihrer Organisation gehört.
`route` gibt die Art des Datensatzes, seine UUID und seine Anwendung an; `source_ref` enthält kein `route` für ein Monitoring-Ereignis oder einen Fall.
Die eigenen Ereignisse des Netzwerks enthalten weder `account` noch `source_ref`.## Verwandte Themen- [Netzwerk abrufen](https://docs.didit.me/de/management-api/networks/get.md)
- [Netzwerksignale](https://docs.didit.me/de/management-api/networks/signals.md)
- [Netzwerkkarte](https://docs.didit.me/de/management-api/networks/map.md)
- [Event-Erfassung](https://docs.didit.me/de/transaction-monitoring/events.md)


## OpenAPI

````yaml de/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/networks/{network_uuid}/timeline/
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/{network_uuid}/timeline/:
    get:
      tags:
        - Networks
      summary: Netzwerk-Zeitleiste abrufen
      description: >-
        Ohne `contract`: Die netzwerkeigenen Ereignisse (Erkennung, neueste
        Beobachtung jedes Signals und dessen Überprüfung), älteste zuerst und
        nicht paginiert. `limit`, `cursor` und `event_type` werden ignoriert.
        Mit `contract=2`: Die typisierte Zeitleiste, neueste zuerst und per
        Cursor paginiert. Sie ergänzt die Aktivitäten der Mitgliedskonten
        (Verifizierungsversuche, Transaktionen, Anmeldungen, die Sie über die
        Events-API übermitteln, und die Live-Regeln, auf die sie gestoßen sind)
        sowie die für das Netzwerk eröffneten Fälle. `note_added`-Ereignisse
        werden nur an Console-Mitglieder zurückgegeben, niemals an einen
        API-Schlüssel. Erfordert einen API-Schlüssel mit Vollzugriff oder
        `read:networks` für ein Console-Mitglied.
      operationId: get_network_timeline
      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: network_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: n3a5e000-0000-4000-8000-000000000001
          description: Netzwerk-UUID.
        - name: contract
          in: query
          required: false
          schema:
            type: string
            enum:
              - '2'
          description: >-
            `2` gibt die typisierte Timeline zurück. Lassen Sie den Parameter
            für die Standard-Timeline weg. Jeder andere Wert gibt 400 zurück.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: >-
            Nur für typisierte Timelines. Ereignisse pro Seite, 1 bis 500.
            Standardwert ist 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Nur typisierte Timeline. Der `next_cursor` der vorherigen Seite. Ein
            ungültiger oder leerer Cursor gibt 400 zurück.
        - name: event_type
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            maxItems: 20
            items:
              type: string
              enum:
                - network_detected
                - signal_observed
                - network_active
                - network_in_review
                - network_resolved
                - network_dismissed
                - verification_attempt
                - transaction
                - login
                - rule_hit
                - case_linked
                - note_added
          description: >-
            Nur für typisierte Timelines. Beizubehaltende Ereignistypen,
            wiederholt oder kommagetrennt, maximal 20 Werte. Standardmäßig alle
            Typen.
      responses:
        '200':
          description: >-
            Ohne `contract`: `{results}`, älteste zuerst, nicht paginiert. Mit
            `contract=2`: `{results, next_cursor}`, neueste zuerst.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/NetworkTimeline'
                  - $ref: '#/components/schemas/NetworkTimelinePage'
              examples:
                Default timeline:
                  summary: Ohne Contract
                  value:
                    results:
                      - event_type: network_detected
                        occurred_at: '2026-10-01T09:12:44Z'
                        label: Network detected
                        metadata:
                          network_id: N-0042
                      - event_type: signal_observed
                        occurred_at: '2026-10-12T16:03:10Z'
                        label: device observed
                        metadata:
                          signal_type: device
                          subject_count: 3
                          is_hub: false
                      - event_type: network_in_review
                        occurred_at: '2026-10-12T16:30:00Z'
                        label: Network in_review
                        metadata:
                          reason: Shared device across three new accounts.
                Typed timeline:
                  summary: Mit contract=2
                  value:
                    results:
                      - id: monitoring_event:9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e
                        event_type: login
                        occurred_at: '2026-10-12T18:41:02Z'
                        ingested_at: '2026-10-12T18:41:03Z'
                        label: Login
                        metadata: {}
                        account:
                          node_id: vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
                          node_type: account
                          uuid: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
                          vendor_data: user-1042
                          display_name: Alex Example
                          ownership: owned
                          route:
                            kind: user
                            id: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
                            application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                        source_ref:
                          kind: monitoring_event
                          id: 9b2f1c3e-4d5a-4b6c-8d7e-0f1a2b3c4d5e
                          ownership: owned
                        verification_attempt: null
                        transaction: null
                        login:
                          action: auth.login
                          succeeded: true
                          status: APPROVED
                          ip:
                            address: 203.0.113.24
                            country_code: ES
                            city: Madrid
                            connection_type: null
                            is_vpn_or_tor: false
                            is_data_center: false
                          device:
                            fingerprint: fp_0a1b2c3d
                            label: Chrome · Android
                          is_first_login: false
                          is_new_device: true
                        rule_hit: null
                        case_linked: null
                        note_added: null
                      - id: session:1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
                        event_type: verification_attempt
                        occurred_at: '2026-10-12T16:03:10Z'
                        ingested_at: '2026-10-12T16:03:10Z'
                        label: Verification attempt 2 of 2
                        metadata: {}
                        account:
                          node_id: vendor_user:5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
                          node_type: account
                          uuid: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
                          vendor_data: user-1042
                          display_name: Alex Example
                          ownership: owned
                          route:
                            kind: user
                            id: 5f6e7d8c-9b0a-4c1d-8e2f-3a4b5c6d7e8f
                            application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                        source_ref:
                          kind: session
                          id: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
                          ownership: owned
                          route:
                            kind: session
                            id: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
                            application_id: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
                        verification_attempt:
                          session_id: 1c2d3e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f
                          session_number: 1287
                          attempt: 2
                          attempt_count: 2
                          status: Approved
                          status_changed_at: '2026-10-12T16:05:41Z'
                          decline_reasons: []
                        transaction: null
                        login: null
                        rule_hit: null
                        case_linked: null
                        note_added: null
                      - id: signal_observed:8d7c6b5a-4e3f-4a2b-9c1d-0e9f8a7b6c5d
                        event_type: signal_observed
                        occurred_at: '2026-10-12T16:03:10Z'
                        ingested_at: '2026-10-01T09:12:44Z'
                        label: device observed
                        metadata:
                          signal_type: device
                          subject_count: 3
                          is_hub: false
                        account: null
                        source_ref: null
                        verification_attempt: null
                        transaction: null
                        login: null
                        rule_hit: null
                        case_linked: null
                        note_added: null
                    next_cursor: >-
                      eyJ0IjoiMjAyNi0xMC0xMlQxNjowMzoxMCswMDowMCIsImMiOiIyMDI2LTEwLTAxVDA5OjEyOjQ0KzAwOjAwIiwiciI6MSwidSI6IjhkN2M2YjVhLTRlM2YtNGEyYi05YzFkLTBlOWY4YTdiNmM1ZCJ9
        '400':
          description: >-
            Wenn `contract` vorhanden ist: ein ungültiger `contract`-, `limit`-,
            `cursor`- oder `event_type`-Wert.
          content:
            application/json:
              examples:
                Unsupported contract:
                  summary: Nicht unterstützter Vertrag
                  value:
                    contract:
                      - '"3" is not a valid choice.'
                Invalid cursor:
                  summary: Ungültiger Cursor
                  value:
                    cursor:
                      - This cursor is not valid. Reload the feed.
                Limit too large:
                  summary: Limit zu groß
                  value:
                    limit:
                      - Ensure this value is less than or equal to 500.
                Unknown event type:
                  summary: Unbekannter Ereignistyp
                  value:
                    event_type:
                      '0':
                        - '"logout" is not a valid choice.'
        '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 `read: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.
        '404':
          description: Netzwerk nicht gefunden (oder für diese Anwendung nicht sichtbar).
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
      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/n3a5e000-0000-4000-8000-000000000001/timeline/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: curl
          label: curl (typed timeline)
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/networks/3fa85f64-5717-4562-b3fc-2c963f66afa6/timeline/?contract=2&limit=50&event_type=verification_attempt,login'
            \
              -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()

            result = client.networks.retrieve_timeline(
                "n3a5e000-0000-4000-8000-000000000001",
            )
            print(result)
        - 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();


            const result = await
            didit.networks.retrieveTimeline("n3a5e000-0000-4000-8000-000000000001");

            console.log(result);
        - 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\nresult, err := client.Networks.RetrieveTimeline(ctx, \"n3a5e000-0000-4000-8000-000000000001\", didit.NetworksRetrieveTimelineParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            Didit client = new Didit();


            var result =
            client.networks().retrieveTimeline("n3a5e000-0000-4000-8000-000000000001");

            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            $didit = new DiditClient();


            $result =
            $didit->networks->retrieveTimeline('n3a5e000-0000-4000-8000-000000000001');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            # and DIDIT_APPLICATION_ID.

            didit = Didit::Client.new


            result =
            didit.networks.retrieve_timeline("n3a5e000-0000-4000-8000-000000000001")

            puts result.to_h
        - 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();


            var result = await
            client.Networks.RetrieveTimelineAsync("n3a5e000-0000-4000-8000-000000000001");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    NetworkTimeline:
      title: Default timeline (no contract)
      type: object
      description: >-
        Ohne `contract`: Die netzwerkeigenen Ereignisse, älteste zuerst, nicht
        paginiert.
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/NetworkTimelineEvent'
    NetworkTimelinePage:
      title: Typed timeline page (contract=2)
      type: object
      description: 'Mit `contract=2`: Eine Seite typisierter Ereignisse, neueste zuerst.'
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/NetworkTypedTimelineEvent'
        next_cursor:
          type: string
          nullable: true
          description: >-
            Als `cursor` übergeben, um die nächste Seite zu lesen. Null auf der
            letzten Seite.
    NetworkTimelineEvent:
      type: object
      properties:
        event_type:
          type: string
          description: >-
            z. B. network_detected, signal_observed, network_in_review,
            network_resolved, network_dismissed.
        occurred_at:
          type: string
          format: date-time
          nullable: true
        label:
          type: string
        metadata:
          type: object
    NetworkTypedTimelineEvent:
      type: object
      description: >-
        Ein typisiertes Timeline-Ereignis: die vier Standardfelder plus dessen
        ID, der Zeitpunkt der Speicherung durch Didit, das zugehörige
        Mitgliedskonto und der Datensatz sowie der Detailblock seines
        Ereignistyps. Die anderen Detailblöcke sind null.
      properties:
        id:
          type: string
          description: '`<source>:<uuid>`, eindeutig innerhalb der Timeline.'
          example: session:3fa85f64-5717-4562-b3fc-2c963f66afa6
        event_type:
          type: string
          enum:
            - network_detected
            - signal_observed
            - network_active
            - network_in_review
            - network_resolved
            - network_dismissed
            - verification_attempt
            - transaction
            - login
            - rule_hit
            - case_linked
            - note_added
        occurred_at:
          type: string
          format: date-time
          description: Wann es stattgefunden hat.
        ingested_at:
          type: string
          format: date-time
          description: Wann Didit dies gespeichert hat.
        label:
          type: string
          description: >-
            Ein kurzes englisches Label, zum Beispiel `Verification attempt 2 of
            3`.
        metadata:
          type: object
          description: >-
            Für die eigenen Ereignisse des Netzwerks: dieselben Metadaten wie
            bei der Standard-Timeline. Andernfalls leer.
        account:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineAccount'
          nullable: true
          description: >-
            Das Mitgliedskonto. Null für die eigenen Ereignisse des Netzwerks,
            `case_linked` und `note_added`.
        source_ref:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineSourceRef'
          nullable: true
          description: >-
            Der Quelldatensatz. Null für die eigenen Ereignisse des Netzwerks
            und `note_added`.
        verification_attempt:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineAttempt'
          nullable: true
          description: Wird bei `verification_attempt`-Ereignissen gesetzt.
        transaction:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineTransaction'
          nullable: true
          description: Wird bei `transaction`-Ereignissen gesetzt.
        login:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineLogin'
          nullable: true
          description: Wird bei `login`-Ereignissen gesetzt.
        rule_hit:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineRuleHit'
          nullable: true
          description: Wird bei `rule_hit`-Ereignissen gesetzt.
        case_linked:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineCaseLinked'
          nullable: true
          description: Wird bei `case_linked`-Ereignissen gesetzt.
        note_added:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineNoteAdded'
          nullable: true
          description: >-
            Wird bei `note_added`-Ereignissen gesetzt. Wird niemals an einen
            API-Schlüssel zurückgegeben.
    NetworkTimelineAccount:
      type: object
      description: Das Mitgliedskonto, zu dem das Ereignis gehört.
      properties:
        node_id:
          type: string
          description: >-
            `<kind>:<uuid>`, wobei kind `vendor_user`, `vendor_business` oder
            `transaction_party` ist.
          example: vendor_user:3fa85f64-5717-4562-b3fc-2c963f66afa6
        node_type:
          type: string
          enum:
            - account
            - business_account
            - transaction_party
        uuid:
          type: string
          format: uuid
        vendor_data:
          type: string
          nullable: true
        display_name:
          type: string
          nullable: true
        ownership:
          type: string
          enum:
            - owned
            - organization
          description: >-
            `owned`, wenn der Datensatz zu der Anwendung gehört, die Sie
            aufgerufen haben (für ein Konsolenmitglied zu einer Anwendung, für
            die ihm Zugriff gewährt wurde). `organization`, wenn er zu einer
            anderen Anwendung Ihrer Organisation gehört.
        route:
          $ref: '#/components/schemas/NetworkTimelineRoute'
    NetworkTimelineSourceRef:
      type: object
      description: Der Datensatz, aus dem das Ereignis gelesen wurde.
      properties:
        kind:
          type: string
          enum:
            - session
            - business_session
            - transaction
            - monitoring_event
            - case
        id:
          type: string
          format: uuid
        ownership:
          type: string
          enum:
            - owned
            - organization
          description: >-
            `owned`, wenn der Datensatz zu der Anwendung gehört, die Sie
            aufgerufen haben (für ein Konsolenmitglied zu einer Anwendung, für
            die ihm Zugriff gewährt wurde). `organization`, wenn er zu einer
            anderen Anwendung Ihrer Organisation gehört.
        route:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineRoute'
          description: Nicht vorhanden für `monitoring_event` und `case`.
    NetworkTimelineAttempt:
      type: object
      description: Eine Verifizierungssitzung des Kontos.
      properties:
        session_id:
          type: string
          format: uuid
          description: >-
            Die Sitzungs-UUID oder die Business-Sitzungs-UUID für ein
            Unternehmen.
        session_number:
          type: integer
          nullable: true
        attempt:
          type: integer
          description: >-
            Die Position dieser Sitzung unter den Sitzungen des Kontos, geordnet
            nach Erstellungsdatum.
        attempt_count:
          type: integer
          description: Wie viele Sitzungen das Konto hat.
        status:
          type: string
          description: Der Sitzungsstatus, zum Beispiel `Approved` oder `Declined`.
        status_changed_at:
          type: string
          format: date-time
          nullable: true
        decline_reasons:
          type: array
          items:
            $ref: '#/components/schemas/NetworkTimelineDeclineReason'
          description: >-
            Nur für eine abgelehnte Sitzung: deren Warnungen, älteste zuerst,
            einmal pro Warnung. Andernfalls leer.
    NetworkTimelineTransaction:
      type: object
      description: >-
        Eine Transaktion, an der ein Mitgliedskonto beteiligt war, datiert mit
        dem Transaktionsdatum.
      properties:
        transaction_id:
          type: string
          format: uuid
        transaction_number:
          type: integer
          nullable: true
        transaction_type:
          type: string
        action_type:
          type: string
        amount:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineAmount'
          nullable: true
          description: Null, wenn die Transaktion keinen Betrag hat.
        status:
          type: string
        decision_reason_code:
          type: string
          nullable: true
        decision_reason_label:
          type: string
          nullable: true
        party_role:
          type: string
          description: >-
            Die Rolle des Kontos in der Transaktion: `APPLICANT`, `REMITTER`,
            `BENEFICIARY` oder `COUNTERPARTY`.
    NetworkTimelineLogin:
      type: object
      description: >-
        Ein Anmeldeereignis, das Sie für eine Person über die Events-API
        übermittelt haben.
      properties:
        action:
          type: string
          description: >-
            `<event_category>.<action_type>`: `auth.login` oder
            `security.login_succeeded` für eine Anmeldung, `auth.login_failed`
            oder `security.login_failed` für eine fehlgeschlagene Anmeldung.
        succeeded:
          type: boolean
        status:
          type: string
          description: Der Status des Ereignisses.
        ip:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineIP'
          nullable: true
          description: Null, wenn das Ereignis keine IP-Adresse hat.
        device:
          allOf:
            - $ref: '#/components/schemas/NetworkTimelineDevice'
          nullable: true
          description: >-
            Null, wenn das Ereignis keinen Geräte-Fingerabdruck oder Kontext
            hat.
        is_first_login:
          type: boolean
          description: Die erste verzeichnete erfolgreiche Anmeldung des Kontos.
        is_new_device:
          type: boolean
          description: >-
            Eine erfolgreiche Anmeldung von einem Gerät, von dem keine der
            früheren erfolgreichen Anmeldungen des Kontos stammte. Niemals true
            bei der ersten Anmeldung.
    NetworkTimelineRuleHit:
      type: object
      description: >-
        Eine aktive Regel, die auf eine Transaktion oder ein Ereignis eines
        Mitglieds zutraf. Treffer im Testmodus sind nicht enthalten.
      properties:
        rule_id:
          type: string
          format: uuid
        rule_title:
          type: string
        rule_category:
          type: string
        rule_source:
          type: string
        severity:
          type: string
          nullable: true
        score_delta:
          type: integer
        status_target:
          type: string
          nullable: true
        action_summary:
          type: string
          nullable: true
    NetworkTimelineCaseLinked:
      type: object
      description: >-
        Ein für das Netzwerk in Ihrer Organisation eröffneter Fall.
        `source_ref.ownership` gibt an, ob er zu der von Ihnen aufgerufenen
        Anwendung gehört.
      properties:
        case_id:
          type: string
          format: uuid
        case_number:
          type: string
          nullable: true
        status:
          type: string
        author_email:
          type: string
          nullable: true
        author_name:
          type: string
          nullable: true
    NetworkTimelineNoteAdded:
      type: object
      description: Eine im Netzwerk hinterlassene Notiz. Der Notiztext ist nicht enthalten.
      properties:
        note_id:
          type: string
          format: uuid
        author_email:
          type: string
    NetworkTimelineRoute:
      type: object
      description: >-
        Wo der Datensatz geöffnet wird: seine Art, seine UUID und die Anwendung,
        zu der er gehört.
      properties:
        kind:
          type: string
          description: >-
            `user`, `business` oder `transaction_party` für ein Konto;
            `session`, `business_session` oder `transaction` für einen
            Quelldatensatz.
        id:
          type: string
          format: uuid
        application_id:
          type: string
          format: uuid
    NetworkTimelineDeclineReason:
      type: object
      properties:
        risk:
          type: string
          description: Der Warncode.
        feature:
          type: string
          description: Die Funktion, die die Warnung ausgelöst hat.
        short_description:
          type: string
    NetworkTimelineAmount:
      type: object
      properties:
        value:
          type: string
          description: Dezimalbetrag als Zeichenkette.
        currency:
          type: string
        direction:
          type: string
          nullable: true
    NetworkTimelineIP:
      type: object
      properties:
        address:
          type: string
        country_code:
          type: string
          nullable: true
        city:
          type: string
          nullable: true
        connection_type:
          type: string
          nullable: true
          description: Die Bezeichnung des Verbindungstyps für die Adresse als Freitext.
        is_vpn_or_tor:
          type: boolean
        is_data_center:
          type: boolean
    NetworkTimelineDevice:
      type: object
      properties:
        fingerprint:
          type: string
          nullable: true
        label:
          type: string
          nullable: true
          description: >-
            Ein lesbares Geräte-Label, das aus dem Gerätekontext des Ereignisses
            erstellt wurde.
  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.