跳转到主要内容
POST
curl
备注只是上下文信息,而非决策结果:它永远不会更改交易的 status、score 或警报。审核员可以在 Console 的交易详情中,在 备注 下查看备注。交易的 activities 还会新增一条 TRANSACTION_NOTE_ADDED 条目,您可以通过获取交易读取该条目。 由于备注来自 API 密钥,因此不包含作者信息:actor_email 和 actor_name 为 null。如果需要显示备注的作者,请将其写入备注内容中。使用列出交易备注可以读取完整的时间线。

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

路径参数

transaction_id
string<uuid>
必填

Didit 交易 UUID:由 POST /v3/transactions/ 和 GET /v3/transactions/ 返回的 uuid。不接受您自己的 txn_id。

请求体

application/json
note
string
必填

纯文本备注。首尾空白字符会被修剪,空白备注会被拒绝。无长度限制。

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

要提及的组织成员的邮箱。每个邮箱必须是有效的组织成员邮箱。

响应

备注已创建。

受监控交易的审核时间线上的一条备注。

uuid
string<uuid>
必填

备注标识符。

note
string
必填

纯文本备注内容。

actor_email
string<email> | null
必填

撰写备注或更改状态的 Console 用户的邮箱。通过 API 密钥创建的备注以及 Didit 自动添加的备注为 null。

actor_name
string | null
必填

Console 用户的显示名称(若未设置姓名则为其邮箱)。对于 Didit 自动添加的备注,显示为 Rule Engine。对于使用 API 密钥创建的备注,为 null。

metadata
object
必填

区分不同的备注类型。通过 API 或控制台写入的备注包含 mentioned_emails。在控制台中执行的状态变更包含 type: status_change 以及 previous_status、new_status、reason_code 和 reason_label。Didit 添加的备注包含 source:规则的 add_note 操作对应 rule_action(附带 rule_uuid),而创建用户操作验证会话出现问题时则对应 remediation_session。

created_at
string<date-time>
必填

备注存储的时间。

最后修改于 2026年11月7日