Saltar al contingut principal
POST
curl
Una nota és context, no una decisió: mai no canvia el status, el score ni les alertes de la transacció. Els revisors la veuen a Notes del detall de la transacció a la Console, i les activities de la transacció incorporen una entrada TRANSACTION_NOTE_ADDED, que pots llegir amb Obtenir una transacció. Com que la nota prové d’una clau d’API, no té autor: actor_email i actor_name són null. Si necessites mostrar qui l’ha escrit, inclou-ho al text de la nota. Llegeix la cronologia completa amb Llistar les notes de la transacció.

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

transaction_id
string<uuid>
requerit

UUID de transacció de Didit: el uuid retornat per POST /v3/transactions/ i GET /v3/transactions/. No s'accepta el teu propi txn_id.

Cos

application/json
note
string
requerit

Nota en text pla. Els espais en blanc inicials i finals s'eliminen i es rebutja una nota en blanc. Sense límit de longitud.

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

Correus electrònics dels membres de la teva organització que cal esmentar. Cadascun ha de ser un correu electrònic vàlid d'un membre de l'organització.

Resposta

La nota s'ha creat.

Una nota a la línia temporal de revisió d'una transacció monitorada.

uuid
string<uuid>
requerit

Identificador de la nota.

note
string
requerit

Cos de la nota en text pla.

actor_email
string<email> | null
requerit

Correu electrònic de l'usuari de la Console que ha escrit la nota o ha canviat l'estat. null per a notes creades amb una clau d'API i per a notes que Didit afegeix automàticament.

actor_name
string | null
requerit

Nom visible de l'usuari de la consola (el seu correu electrònic quan no té nom). Rule Engine en les notes que Didit afegeix automàticament. null per a notes creades amb una clau d'API.

metadata
object
requerit

Distingeix els tipus de notes. Les notes escrites a través de l'API o de la consola porten mentioned_emails. Un canvi d'estat fet a la consola porta type: status_change amb previous_status, new_status, reason_code i reason_label. Les notes que Didit afegeix porten source: rule_action (amb rule_uuid) per a l'acció add_note d'una regla, o remediation_session per a un problema en crear la sessió de verificació per a l'acció de l'usuari.

created_at
string<date-time>
requerit

Quan es va desar la nota.

Darrera modificació el 7 de novembre del 2026