taler-docs

commit dad47e3bdf5ffefcb19831910a7f8d1eacd8d57d
parent 97fe58afb2304322ff0a3e94df12371d6e924f37
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sat, 12 Apr 2025 16:03:57 +0200

enable long-polling for kYC status with KYC decision row ID

Diffstat:
M
core/api-exchange.rst
 | 
13
++++++++++++-

1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -1557,7 +1557,7 @@ for details.
       denom_pub_hash: HashCode;
     }
 
-  
+
 
   .. ts:def:: BlindingPrepareResponse
 
@@ -5302,6 +5302,11 @@ regulatory compliance.
     2 to wait for an AML investigation to be done,
     and 3 to wait for the KYC status to be OK.
     @since protocol **v21**.
+  :query min_rule=NUMBER: *Optional*.
+    Specifies the ``rule_num`` of the previous ``kyc-check``
+    already known to the client.  When long-polling, the server
+    should always respond when it has a more recent rule.
+    @since protocol **v26**.
   :query timeout_ms=NUMBER: *Optional.*  If specified, the exchange will
     wait up to ``timeout_ms`` milliseconds if the requirement continues
     to be mandatory provisioning of KYC data by the client.
@@ -5363,6 +5368,12 @@ regulatory compliance.
       // accounts without this flag being set!
       aml_review: boolean;
 
+      // Monotonically increasing number identifying the decision.
+      // 0 if no decision was taken for this account. Useful for
+      // long-polling via ``min_rule`` to long-poll for any change
+      // to the rules or limits.
+      rule_gen: Integer;
+
       // Access token needed to construct the ``/kyc-spa/``
       // URL that the user should open in a browser to
       // proceed with the KYC process (optional if the status