Sitzungsereignisse abrufen API

curl

curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50' \
  -H 'x-api-key: YOUR_API_KEY'

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

// Reads DIDIT_API_KEY.
const didit = new Didit();

for await (const item of didit.sessions.listEvents("11111111-2222-3333-4444-555555555555")) {
  console.log(item);
}

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

iter := client.Sessions.ListEventsAutoPaging(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsListEventsParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

foreach ($didit->sessions->listEvents('11111111-2222-3333-4444-555555555555') as $item) {
    print_r($item->toArray());
}

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

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

await foreach (var item in await client.Sessions.ListEventsAsync("11111111-2222-3333-4444-555555555555"))
{
    Console.WriteLine(JsonSerializer.Serialize(item));
}

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "aaaaaaaa-1111-2222-3333-444444444444",
      "event_type": "SESSION_STATUS_CHANGED",
      "created_at": "2026-09-14T10:02:13.904512Z",
      "component": null,
      "feature_step": null,
      "step": null,
      "details": {
        "old_status": "In Progress",
        "current_status": "Approved"
      },
      "ip_address": null,
      "user_agent": null,
      "device_info": null,
      "file_url": null,
      "sent_at": 1789380131482
    },
    {
      "uuid": "bbbbbbbb-1111-2222-3333-444444444444",
      "event_type": "FEATURE_STEP_CHANGED",
      "created_at": "2026-09-14T10:01:49.210377Z",
      "component": null,
      "feature_step": null,
      "step": null,
      "details": {
        "old_feature_step": "OCR",
        "current_feature_step": "LIVENESS"
      },
      "ip_address": null,
      "user_agent": null,
      "device_info": null,
      "file_url": null,
      "sent_at": 1789380107103
    },
    {
      "uuid": "cccccccc-1111-2222-3333-444444444444",
      "event_type": "STEP_RENDERED",
      "created_at": "2026-09-14T10:01:00.581930Z",
      "component": "DocumentCapture",
      "feature_step": "OCR",
      "step": "DOCUMENT_CAPTURE_FRONT",
      "details": {},
      "ip_address": "203.0.113.24",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1",
      "device_info": {
        "device_model": "iPhone"
      },
      "file_url": null,
      "sent_at": 1789380058776
    }
  ]
}

GET

session

{sessionId}

events

curl

curl -X GET 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/events/?limit=50' \
  -H 'x-api-key: YOUR_API_KEY'

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

// Reads DIDIT_API_KEY.
const didit = new Didit();

for await (const item of didit.sessions.listEvents("11111111-2222-3333-4444-555555555555")) {
  console.log(item);
}

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

iter := client.Sessions.ListEventsAutoPaging(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsListEventsParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

foreach ($didit->sessions->listEvents('11111111-2222-3333-4444-555555555555') as $item) {
    print_r($item->toArray());
}

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

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

await foreach (var item in await client.Sessions.ListEventsAsync("11111111-2222-3333-4444-555555555555"))
{
    Console.WriteLine(JsonSerializer.Serialize(item));
}

{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "aaaaaaaa-1111-2222-3333-444444444444",
      "event_type": "SESSION_STATUS_CHANGED",
      "created_at": "2026-09-14T10:02:13.904512Z",
      "component": null,
      "feature_step": null,
      "step": null,
      "details": {
        "old_status": "In Progress",
        "current_status": "Approved"
      },
      "ip_address": null,
      "user_agent": null,
      "device_info": null,
      "file_url": null,
      "sent_at": 1789380131482
    },
    {
      "uuid": "bbbbbbbb-1111-2222-3333-444444444444",
      "event_type": "FEATURE_STEP_CHANGED",
      "created_at": "2026-09-14T10:01:49.210377Z",
      "component": null,
      "feature_step": null,
      "step": null,
      "details": {
        "old_feature_step": "OCR",
        "current_feature_step": "LIVENESS"
      },
      "ip_address": null,
      "user_agent": null,
      "device_info": null,
      "file_url": null,
      "sent_at": 1789380107103
    },
    {
      "uuid": "cccccccc-1111-2222-3333-444444444444",
      "event_type": "STEP_RENDERED",
      "created_at": "2026-09-14T10:01:00.581930Z",
      "component": "DocumentCapture",
      "feature_step": "OCR",
      "step": "DOCUMENT_CAPTURE_FRONT",
      "details": {},
      "ip_address": "203.0.113.24",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 18_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/18.5 Mobile/15E148 Safari/604.1",
      "device_info": {
        "device_model": "iPhone"
      },
      "file_url": null,
      "sent_at": 1789380058776
    }
  ]
}

Die Workflow-Routing-Ereignisse (WORKFLOW_BRANCH_EVALUATED, WORKFLOW_STATUS_NODE_REACHED) und ihre details werden in Sitzung abrufen beschrieben. Dort kann mit ?include=events außerdem die Zeitleiste einer Sitzung der Benutzerverifizierung (KYC) innerhalb ihrer Entscheidung zurückgegeben werden.

Autorisierungen

x-api-key

string

header

erforderlich

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.

Pfadparameter

sessionId

string<uuid>

erforderlich

UUID der Verifizierungssitzung (die von POST /v3/session/ zurückgegebene session_id). Akzeptiert Sitzungs-IDs sowohl für die Benutzerverifizierung (KYC) als auch für die Unternehmensverifizierung (KYB): Der Server löst die ID über beide Sitzungstypen hinweg auf. Muss eine wohlgeformte UUID sein; ein fehlerhafter Wert entspricht nicht der Route und gibt ein HTML-404 zurück.

Beispiel:

"11111111-2222-3333-4444-555555555555"

Abfrageparameter

limit

integer

Standard:50

Maximale Anzahl an Ereignissen pro Seite. Standardmäßig 50. Ein Wert unter 1 oder ein nicht-numerischer Wert fällt auf 50 zurück; ein Wert über 1.000.000 gibt 400 zurück.

Erforderlicher Bereich: 1 <= x <= 1000000

Beispiel:

50

offset

integer

Standard:0

Anzahl der vor dem ersten zurückgegebenen Ergebnis zu überspringenden Ergebnisse. Standardmäßig 0; ein negativer oder nicht-numerischer Wert fällt auf 0 zurück, ein Wert über 1.000.000 gibt 400 zurück. Folgen Sie vorzugsweise den next- und previous-URLs.

Erforderlicher Bereich: 0 <= x <= 1000000

Beispiel:

0

ordering

string

Optionale Überschreibung der Sortierung. Die Standardreihenfolge ist -sent_at. Übergeben Sie den Namen eines Ergebnisfelds (z. B. sent_at, created_at, event_type, feature_step oder step), um aufsteigend zu sortieren, stellen Sie ein - voran, um absteigend zu sortieren, und trennen Sie mehrere Felder durch Kommas. Unbekannte Felder werden ignoriert.

Beispiel:

"sent_at"

Antwort

Eine Seite mit den Ereignissen der Sitzung, neueste zuerst.

count

integer

erforderlich

Gesamtzahl der Ereignisse der Sitzung.

string<uri> | null

erforderlich

URL der nächsten Seite oder null auf der letzten Seite.

string<uri> | null

erforderlich

URL der vorherigen Seite oder null auf der ersten Seite.

results

object[]

erforderlich

Show child attributes

Zuletzt geändert am 7. November 2026