Skip to main content
GET
curl
Notes are the analyst timeline of a transaction: the same list reviewers see under Notes on the transaction detail in the Console. Add your own with Create transaction note, and read the transaction itself, including its activities, with Get transaction. Notes with actor_name set to Rule Engine come from Didit: a rule’s add_note action, or a problem creating the user-action verification session for a transaction in AWAITING_USER (the session could not be created, or Didit fell back to another workflow).

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.

Query Parameters

limit
integer
default:50

Number of notes per page. Defaults to 50. A value that is not a positive integer falls back to 50; a value above 1000000 returns 400.

Required range: 1 <= x <= 1000000
offset
integer
default:0

Zero-based position of the first note to return. Prefer following next. A value that is not a whole number falls back to 0; a value above 1000000 returns 400.

Required range: 0 <= x <= 1000000

Response

A page of notes, newest first.

count
integer
required

Number of notes on the transaction: exact up to 100, capped at 100 above that. Follow next instead of computing pages from it.

next
string<uri> | null
required

Absolute URL of the next page, or null on the last page.

previous
string<uri> | null
required

Absolute URL of the previous page, or null on the first page.

results
object[]
required