taler-docs

commit 673368b4948d140ce94cacf277bfc8921501ec0c
parent e7b0ea84195bd1388307ff353ab922efa4cc38af
Author: Christian Grothoff <christian@grothoff.org>
Date:   Wed, 21 Jun 2023 19:34:19 +0200

document exchange AML responses

Diffstat:
M
core/api-auditor.rst
 | 
2
++
M
core/api-challenger.rst
 | 
2
+-
M
core/api-exchange.rst
 | 
27
+++++++++++++++++++++++++++
M
core/api-sync.rst
 | 
2
++

4 files changed, 32 insertions(+), 1 deletion(-)
diff --git a/core/api-auditor.rst b/core/api-auditor.rst
@@ -24,6 +24,8 @@ for all details not specified in the individual requests.
 The `glossary <https://docs.taler.net/glossary.html#glossary>`_
 defines all specific terms used in this section.
 
+.. contents:: Table of Contents
+
 .. _auditor-version:
 
 -------------------------
diff --git a/core/api-challenger.rst b/core/api-challenger.rst
@@ -87,7 +87,7 @@ the resource.
 Using the ``/info`` endpoint the client can then finally obtain the (now)
 verified address of the user.
 
-
+.. contents:: Table of Contents
 
 .. include:: tos.rst
 
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -24,6 +24,8 @@ for all details not specified in the individual requests.
 The `glossary <https://docs.taler.net/glossary.html#glossary>`_
 defines all specific terms used in this section.
 
+.. contents:: Table of Contents
+
 .. include:: tos.rst
 
 .. _keys:
@@ -5089,6 +5091,9 @@ KYC status updates
     The provided hash does not match the payment target.
   :http:statuscode:`404 Not found`:
     The payment target is unknown.
+  :http:statuscode:`451 Unavailable for Legal Reasons`:
+    The transaction cannot be completed due to AML rules.
+    The response will be a `AccountAmlBlocked` object.
 
   **Details:**
 
@@ -5112,6 +5117,12 @@ KYC status updates
 
       // public key used to create the signature.
       exchange_pub: EddsaPublicKey;
+
+      // Current AML state for the target account. Non-zero
+      // values indicate that the transfer is blocked due to
+      // AML enforcement.
+      aml_status: Integer;
+
     }
 
   .. ts:def:: AccountKycRedirect
@@ -5122,6 +5133,22 @@ KYC status updates
       // proceed with the KYC process.
       kyc_url: string;
 
+      // Current AML state for the target account. Non-zero
+      // values indicate that the transfer is blocked due to
+      // AML enforcement.
+      aml_status: Integer;
+
+    }
+
+  .. ts:def:: AccountAmlBlocked
+
+    interface AccountAmlBlocked {
+
+      // Current AML state for the target account. Non-zero
+      // values indicate that the transfer is blocked due to
+      // AML enforcement.
+      aml_status: Integer;
+
     }
 
   .. ts:def:: KycDetails
diff --git a/core/api-sync.rst b/core/api-sync.rst
@@ -102,6 +102,8 @@ over TLS, and that the synchronization service is trusted to not build
 user's location profiles by linking client IP addresses and client
 keys.
 
+.. contents:: Table of Contents
+
 
 .. include:: tos.rst