Saltar al contenido principal
POST
curl
Una nota aporta contexto, no es una decisión: nunca cambia el status, el score ni las alertas de la transacción. Los revisores la ven en Notas del detalle de la transacción de la Console, y las activities de la transacción reciben una entrada TRANSACTION_NOTE_ADDED, que puedes leer con Obtener transacción. Como la nota procede de una clave de API, no tiene autor: actor_email y actor_name son null. Si necesitas mostrar quién la escribió, inclúyelo en el texto de la nota. Consulta el historial completo con Listar notas de transacción.

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Parámetros de ruta

transaction_id
string<uuid>
requerido

UUID de transacción de Didit: el uuid que devuelven POST /v3/transactions/ y GET /v3/transactions/. No se acepta tu propio txn_id.

Cuerpo

application/json
note
string
requerido

Nota en texto plano. Se eliminan los espacios en blanco al principio y al final, y se rechaza una nota vacía. Sin límite de longitud.

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

Correos electrónicos de los miembros de tu organización a los que mencionar. Cada uno debe ser un correo válido de un miembro de la organización.

Respuesta

Se creó la nota.

Una nota en la cronología de revisión de una transacción monitorizada.

uuid
string<uuid>
requerido

Identificador de la nota.

note
string
requerido

Cuerpo de la nota en texto plano.

actor_email
string<email> | null
requerido

Correo electrónico del usuario de la consola que escribió la nota o cambió el estado. null para las notas creadas con una clave de API y para las notas que Didit añade automáticamente.

actor_name
string | null
requerido

Nombre visible del usuario de la Console (su correo electrónico si no tiene nombre). Rule Engine en las notas que Didit añade automáticamente. null en las notas creadas con una clave de API.

metadata
object
requerido

Distingue los tipos de nota. Las notas escritas mediante la API o la consola incluyen mentioned_emails. Un cambio de estado realizado en la consola incluye type: status_change con previous_status, new_status, reason_code y reason_label. Las notas que añade Didit incluyen source: rule_action (con rule_uuid) para la acción add_note de una regla, o remediation_session para un problema al crear la sesión de verificación de acción del usuario.

created_at
string<date-time>
requerido

Fecha y hora en que se almacenó la nota.

Última modificación el 1 de noviembre de 2026