Passer au contenu principal
POST
curl
Une note apporte du contexte, elle n’est pas une décision : elle ne modifie jamais le status, le score ni les alertes de la transaction. Les réviseurs la voient sous Notes sur le détail de la transaction dans la Console, et les activities de la transaction reçoivent une entrée TRANSACTION_NOTE_ADDED, que vous pouvez lire avec Get transaction. Comme la note provient d’une clé API, elle n’a pas d’auteur : actor_email et actor_name valent null. Si vous devez indiquer qui l’a rédigée, incluez cette information dans le texte de la note. Relisez l’historique complet avec List transaction notes.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Paramètres de chemin

transaction_id
string<uuid>
requis

UUID de transaction Didit : le uuid renvoyé par POST /v3/transactions/ et GET /v3/transactions/. Votre propre txn_id n'est pas accepté.

Corps

application/json
note
string
requis

Note en texte brut. Les espaces de début et de fin sont supprimés et une note vide est rejetée. Aucune limite de longueur.

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

E-mails des membres de votre organisation à mentionner. Chacun doit être un e-mail valide d'un membre de l'organisation.

Réponse

La note a été créée.

Une note dans la chronologie d'examen d'une transaction surveillée.

uuid
string<uuid>
requis

Identifiant de la note.

note
string
requis

Corps de la note en texte brut.

actor_email
string<email> | null
requis

E-mail de l'utilisateur de la Console ayant rédigé la note ou modifié le statut. null pour les notes créées avec une clé API et pour les notes ajoutées automatiquement par Didit.

actor_name
string | null
requis

Nom d'affichage de l'utilisateur de la Console (son e-mail lorsqu'il n'a pas de nom). Rule Engine pour les notes ajoutées automatiquement par Didit. null pour les notes créées avec une clé API.

metadata
object
requis

Distingue les types de notes. Les notes rédigées via l'API ou la Console contiennent mentioned_emails. Un changement de statut effectué dans la Console contient type: status_change avec previous_status, new_status, reason_code et reason_label. Les notes ajoutées par Didit contiennent source : rule_action (avec rule_uuid) pour l'action add_note d'une règle, ou remediation_session pour un problème de création de la session de vérification d'action utilisateur.

created_at
string<date-time>
requis

Moment où la note a été enregistrée.

Dernière modification le 7 novembre 2026