Zum Hauptinhalt springen
POST
curl

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.

Header

Content-Type
string

Auf application/json setzen, wenn ein JSON-Body gesendet wird.

Beispiel:

"application/json"

Pfadparameter

session_id
string<uuid>
erforderlich

UUID der Sitzung zur Benutzerverifizierung (KYC). Muss zu derselben Anwendung wie der API-Schlüssel gehören — anwendungsübergreifende UUIDs, gelöschte Sitzungen und Sitzungs-IDs der Unternehmensverifizierung (KYB) geben alle 404 zurück.

Beispiel:

"8c2f3a14-7e9b-4d23-9e83-3f7d5e8a1c6d"

Body

application/json
new_status
enum<string> | null

Optionales Status-Label, das für den Eintrag erfasst werden soll. Akzeptiert jeden Sitzungsstatuswert unter Beachtung der Groß-/Kleinschreibung ("approved" wird mit 400 abgelehnt). Das Erfassen eines Status an dieser Stelle ändert nicht den tatsächlichen Status der Sitzung – verwenden Sie dafür den Endpoint zur Statusaktualisierung.

Verfügbare Optionen:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User
Beispiel:

"In Review"

comment
string | null

Optionale Freitextnotiz (keine erzwungene Längenbegrenzung). Wird wortgetreu gespeichert; @email-Erwähnungen werden an diesem Endpoint nicht verarbeitet.

Beispiel:

"Flagging for manual document re-check."

Antwort

Eintrag, der im Audit-Log der Sitzung aufgezeichnet wurde. Die Sitzung selbst bleibt unverändert – ihr status behält seinen vorherigen Wert und es wird kein Webhook gesendet. Der neue Eintrag erscheint auch ganz oben bei GET …/reviews/ (mit actor_display: "Unknown").

user
string

Anzeigename des Autors des Eintrags. Immer "Unknown" für Einträge, die über diesen Endpoint erstellt wurden, da er keine Akteurszuordnung erfasst.

Beispiel:

"Unknown"

new_status
enum<string> | null

Das für den Eintrag erfasste Statuslabel oder null, wenn keines gesendet wurde. Der tatsächliche Status der Sitzung ist davon nicht betroffen.

Verfügbare Optionen:
Not Started,
In Progress,
Approved,
Declined,
In Review,
Expired,
Abandoned,
Kyc Expired,
Resubmitted,
Awaiting User
Beispiel:

"In Review"

comment
string | null

Die für den Eintrag erfasste Notiz oder null, wenn keine gesendet wurde.

Beispiel:

"Flagging for manual document re-check."

created_at
string<date-time>

Wann der Eintrag geschrieben wurde, ISO 8601 UTC.

Beispiel:

"2026-06-12T00:18:44.466537Z"

Zuletzt geändert am 7. November 2026