Skip to main content
POST
curl
A note is context, not a decision: it never changes the transaction’s status, score or alerts. Reviewers see it under Notes on the transaction detail in the Console, and the transaction’s activities gain a TRANSACTION_NOTE_ADDED entry, which you can read with Get transaction. Because the note comes from an API key, it carries no author: actor_email and actor_name are null. If you need to show who wrote it, include that in the note text. Read the full timeline back with List transaction notes.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

transaction_id
string<uuid>
required

Didit transaction UUID: the uuid returned by POST /v3/transactions/ and GET /v3/transactions/. Your own txn_id is not accepted.

Body

application/json
note
string
required

Plain-text note. Leading and trailing whitespace is trimmed and a blank note is rejected. No length limit.

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

Emails of members of your organization to mention. Each must be a valid email of an organization member.

Response

The note was created.

One note on a monitored transaction's review timeline.

uuid
string<uuid>
required

Note identifier.

note
string
required

Plain-text note body.

actor_email
string<email> | null
required

Email of the Console user who wrote the note or changed the status. null for notes created with an API key and for notes Didit adds automatically.

actor_name
string | null
required

Display name of the Console user (their email when they have no name). Rule Engine on notes Didit adds automatically. null for notes created with an API key.

metadata
object
required

Tells the note types apart. Notes written through the API or the Console carry mentioned_emails. A status change made in the Console carries type: status_change with previous_status, new_status, reason_code and reason_label. Notes Didit adds carry source: rule_action (with rule_uuid) for a rule's add_note action, or remediation_session for a problem creating the user-action verification session.

created_at
string<date-time>
required

When the note was stored.