Langsung ke konten utama
POST
curl
Catatan adalah konteks, bukan keputusan: catatan tidak pernah mengubah status, score, atau alert pada transaksi. Peninjau melihatnya di bagian Catatan pada detail transaksi di Console, dan activities transaksi akan mendapatkan entri TRANSACTION_NOTE_ADDED, yang dapat Anda baca dengan Ambil transaksi. Karena catatan berasal dari kunci API, catatan tidak memiliki penulis: actor_email dan actor_name bernilai null. Jika Anda perlu menampilkan siapa yang menulisnya, sertakan informasi tersebut di dalam teks catatan. Baca kembali linimasa lengkapnya dengan Daftar catatan transaksi.

Otorisasi

x-api-key
string
header
wajib

Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.

Parameter Path

transaction_id
string<uuid>
wajib

UUID transaksi Didit: uuid yang dikembalikan oleh POST /v3/transactions/ dan GET /v3/transactions/. txn_id Anda sendiri tidak diterima.

Body

application/json
note
string
wajib

Catatan teks biasa. Spasi di awal dan akhir akan dipangkas dan catatan kosong akan ditolak. Tidak ada batas panjang.

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

Email anggota organisasi Anda yang akan disebutkan. Masing-masing harus berupa email valid dari anggota organisasi.

Respons

Catatan berhasil dibuat.

Satu catatan pada linimasa peninjauan transaksi yang dipantau.

uuid
string<uuid>
wajib

Pengidentifikasi catatan.

note
string
wajib

Isi catatan teks biasa.

actor_email
string<email> | null
wajib

Email pengguna Console yang menulis catatan atau mengubah status. null untuk catatan yang dibuat dengan kunci API dan untuk catatan yang ditambahkan Didit secara otomatis.

actor_name
string | null
wajib

Nama tampilan pengguna Console (email mereka jika mereka tidak memiliki nama). Rule Engine pada catatan yang ditambahkan Didit secara otomatis. null untuk catatan yang dibuat dengan kunci API.

metadata
object
wajib

Membedakan jenis catatan. Catatan yang ditulis melalui API atau Konsol memuat mentioned_emails. Perubahan status yang dilakukan di Konsol membawa type: status_change beserta previous_status, new_status, reason_code, dan reason_label. Catatan yang ditambahkan Didit membawa source: rule_action (dengan rule_uuid) untuk tindakan add_note aturan, atau remediation_session untuk masalah pembuatan sesi verifikasi tindakan pengguna.

created_at
string<date-time>
wajib

Waktu catatan disimpan.

Terakhir diubah pada 7 November 2026