Vai al contenuto principale
POST
curl
Una nota fornisce contesto, non è una decisione: non modifica mai lo status, lo score né gli alert della transazione. I revisori la vedono nella sezione Note del dettaglio della transazione nella Console, e le activities della transazione si arricchiscono di una voce TRANSACTION_NOTE_ADDED, che puoi leggere con Ottieni transazione. Poiché la nota proviene da una chiave API, non ha un autore: actor_email e actor_name sono null. Se devi mostrare chi l’ha scritta, includi questa informazione nel testo della nota. Leggi la cronologia completa con Elenca le note della transazione.

Autorizzazioni

x-api-key
string
header
obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Parametri del percorso

transaction_id
string<uuid>
obbligatorio

UUID della transazione Didit: l'uuid restituito da POST /v3/transactions/ e GET /v3/transactions/. Il tuo txn_id personale non è accettato.

Corpo

application/json
note
string
obbligatorio

Nota in testo normale. Gli spazi vuoti iniziali e finali vengono rimossi e una nota vuota viene rifiutata. Nessun limite di lunghezza.

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

Indirizzi email dei membri della tua organizzazione da menzionare. Ognuno deve essere un'email valida di un membro dell'organizzazione.

Risposta

La nota è stata creata.

Una nota sulla cronologia di revisione di una transazione monitorata.

uuid
string<uuid>
obbligatorio

Identificatore della nota.

note
string
obbligatorio

Corpo della nota in testo normale.

actor_email
string<email> | null
obbligatorio

Email dell'utente della Console che ha scritto la nota o modificato lo stato. null per le note create con una chiave API e per le note aggiunte automaticamente da Didit.

actor_name
string | null
obbligatorio

Nome visualizzato dell'utente della Console (la sua email se non ha un nome). Rule Engine per le note aggiunte automaticamente da Didit. null per le note create con una chiave API.

metadata
object
obbligatorio

Distingue le tipologie di note. Le note inserite tramite l'API o la Console includono mentioned_emails. Una modifica di stato effettuata nella Console include type: status_change con previous_status, new_status, reason_code e reason_label. Le note aggiunte da Didit contengono source: rule_action (con rule_uuid) per l'azione add_note di una regola, oppure remediation_session in caso di errore nella creazione della sessione di verifica dell'azione utente.

created_at
string<date-time>
obbligatorio

Quando la nota è stata salvata.

Ultima modifica il 7 novembre 2026