taler-docs

commit 92393155bfe274838b822e0c5c6c863ef03d46cc
parent d2678f76a06d73292777d94831741963d2bd6914
Author: Florian Dold <dold@taler.net>
Date:   Sun, 30 Aug 2026 01:50:48 +0200

exchange AML API: clarify account listing semantics

Diffstat:
M
core/exchange/get-aml-OFFICER_PUB-accounts.rst
 | 
24
+++++++++++++++---------

1 file changed, 15 insertions(+), 9 deletions(-)
diff --git a/core/exchange/get-aml-OFFICER_PUB-accounts.rst b/core/exchange/get-aml-OFFICER_PUB-accounts.rst
@@ -30,15 +30,16 @@
     Do not give (or use "all") to see all accounts regardless of
     investigation status.
   :query open:
-    *Optional*. If set to yes, only return accounts that are open,
-    which means they crossed some initial limit and now have custom rules.
-    Do not give (or use "all") to see all accounts regardless of
-    open status.
+    *Optional*. If set to yes, only return accounts whose AML file is
+    currently open.  An AML file is open after an ``ACCOUNT_OPEN`` event and
+    until a later ``ACCOUNT_IDLE`` event closes it.  If set to no, only return
+    accounts whose AML file is closed or was never opened.  Do not give this
+    parameter (or use "all") to see all accounts regardless of open status.
   :query high_risk:
     *Optional*. If set to yes, only return accounts that were flagged
-    as high risk.
-    Do not give (or use "all") to see all accounts regardless of
-    risk status.
+    as high risk.  If set to no, only return accounts that are not flagged as
+    high risk.  Do not give this parameter (or use "all") to see all accounts
+    regardless of risk status.
 
   **Response:**
 
@@ -97,9 +98,14 @@
       // True if the account was assessed as being high risk.
       high_risk: boolean;
 
-      // Latest comments about the account (if any).
+      // Latest officer-authored file note about the account (if any).
       comments?: string;
 
+      // Machine-readable system information about the account (if any).
+      // "BELOW_ACCOUNT_OPENING_THRESHOLD" means that transactions remain
+      // below the threshold that opens an AML file.
+      system_note?: "BELOW_ACCOUNT_OPENING_THRESHOLD";
+
       // Row of the account in the exchange tables. Useful to filter
       // by offset.
       rowid: Integer;
@@ -107,7 +113,7 @@
       // When was the account opened? "never" if it was never opened.
       open_time: Timestamp;
 
-      // When was the account opened? "never" if it was never closed.
+      // When was the account closed? "never" if it was never closed.
       close_time: Timestamp;
 
       // True if the account is under investigation by AML staff