Zum Hauptinhalt springen
POST
curl
Eine Notiz dient als Kontext und ist keine Entscheidung. Sie ändert nie den status, den score oder die Alerts der Transaktion. Prüfer sehen sie unter Notizen in den Transaktionsdetails in der Konsole. Die activities der Transaktion erhalten zudem einen Eintrag TRANSACTION_NOTE_ADDED, den Sie mit Transaktion abrufen auslesen können. Da die Notiz über einen API-Schlüssel erstellt wird, enthält sie keinen Autor: actor_email und actor_name sind null. Wenn Sie anzeigen möchten, wer die Notiz geschrieben hat, nehmen Sie diese Information in den Notiztext auf. Den vollständigen Verlauf rufen Sie mit Transaktionsnotizen auflisten ab.

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

transaction_id
string<uuid>
erforderlich

Didit-Transaktions-UUID: die von POST /v3/transactions/ und GET /v3/transactions/ zurückgegebene uuid. Ihre eigene txn_id wird nicht akzeptiert.

Body

application/json
note
string
erforderlich

Klartext-Notiz. Führende und nachgestellte Leerzeichen werden entfernt, und eine leere Notiz wird abgelehnt. Keine Längenbegrenzung.

Minimum string length: 1
mentioned_emails
string<email>[]

E-Mail-Adressen von Mitgliedern Ihrer Organisation, die erwähnt werden sollen. Jede muss eine gültige E-Mail-Adresse eines Organisationsmitglieds sein.

Antwort

Die Notiz wurde erstellt.

Eine Notiz in der Prüfungs-Timeline einer überwachten Transaktion.

uuid
string<uuid>
erforderlich

Notizkennung.

note
string
erforderlich

Notiztext als Klartext.

actor_email
string<email> | null
erforderlich

E-Mail des Console-Benutzers, der die Notiz verfasst oder den Status geändert hat. null für mit einem API-Schlüssel erstellte Notizen und für Notizen, die Didit automatisch hinzufügt.

actor_name
string | null
erforderlich

Anzeigename des Console-Benutzers (seine E-Mail-Adresse, wenn er keinen Namen hat). Rule Engine bei Notizen, die Didit automatisch hinzufügt. null bei Notizen, die mit einem API-Schlüssel erstellt wurden.

metadata
object
erforderlich

Unterscheidet die Notiztypen. Über die API oder die Console verfasste Notizen enthalten mentioned_emails. Eine in der Console vorgenommene Statusänderung enthält type: status_change mit previous_status, new_status, reason_code und reason_label. Von Didit hinzugefügte Notizen enthalten source: rule_action (mit rule_uuid) für die Aktion add_note einer Regel oder remediation_session für ein Problem beim Erstellen der Verifizierungssitzung für Benutzeraktionen.

created_at
string<date-time>
erforderlich

Wann die Notiz gespeichert wurde.

Zuletzt geändert am 7. November 2026