commit 5ef4bb750d461f5f0650b238819e821329794bb6
parent 11b087e82244f171b386a3d53facee7a43727983
Author: Christian Grothoff <christian@grothoff.org>
Date: Thu, 8 Aug 2024 18:50:33 +0200
update kyc-wallet spec: communicate next threshold and expiration
Diffstat:
2 files changed, 34 insertions(+), 17 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -4612,11 +4612,15 @@ regulatory compliance.
**Response:**
- :http:statuscode:`204 No Content`:
- KYC is disabled at this exchange, or the balance
+ :http:statuscode:`200 Ok`:
+ The balance
is below the threshold that requires KYC, or this
wallet already satisfied the KYC check for the
- given balance.
+ given balance. The `WalletKycCheckResponse` body
+ give details about the next applicable KYC check
+ requirements.
+ :http:statuscode:`204 No Content`:
+ KYC is disabled at this exchange.
:http:statuscode:`403 Forbidden`:
The provided signature is invalid.
This response comes with a standard `ErrorDetail` response.
@@ -4645,6 +4649,22 @@ regulatory compliance.
reserve_pub: EddsaPublicKey;
}
+ .. ts:def:: WalletKycCheckResponse
+
+ interface WalletKycCheckResponse {
+
+ // Next balance limit above which a KYC check
+ // may be required.
+ next_threshold: Amount;
+
+ // When does the current set of AML/KYC rules
+ // expire and the wallet needs to check again
+ // for updated thresholds.
+ expiration_time: Timestamp;
+
+ }
+
+
.. http:get:: /kyc-check/$REQUIREMENT_ROW
Checks the KYC status of a particular payment target and possibly begins a
diff --git a/taler-kyc-manual.rst b/taler-kyc-manual.rst
@@ -39,21 +39,16 @@ About GNU Taler
About this manual
-----------------
-This manual targets compliance experts working with system administrators to
-configure legitimization (KYC/KYB) and anti-money laundering (AML) processes
-for a GNU Taler exchange.
-
-
-
-
-.. _LegalSetup:
+This chapter describes how to setup certain compliance aspects of a GNU Taler
+exchange. Users that just want to set up an exchange as an experiment without
+legal or regulatory requirements can safely skip this chapter.
-Legal Setup
-===========
+This manual targets compliance experts working with system administrators and
+developers to configure legitimization (KYC/KYB) and anti-money laundering
+(AML) processes for a GNU Taler exchange. Expertise in all three domains is
+required, as Taler's KYC and AML processes are highly configurable and
+programmable.
-This chapter describes how to setup certain legal aspects of a GNU Taler
-exchange. Users that just want to set up an exchange as an experiment without
-legal requirements can safely skip these steps.
Legal conditions for using the service
@@ -69,12 +64,14 @@ To legally operate, Taler exchange operators may have to comply with KYC
regulation that requires financial institutions to identify parties involved
in transactions at certain points.
-Taler permits an exchange to require KYC data under the following circumstances:
+Taler permits an exchange to require know-your-customer (KYC) or
+know-your-business (KYB) data under the following circumstances:
* Customer withdraws money over a threshold
* Wallet receives (via refunds) money resulting in a balance over a threshold
* Wallet receives money via P2P payments over a threshold
* Merchant receives money over a threshold
+ * Merchant deposits digital cash over a threshold (**planned feature**)
* Reserve is "opened" for invoicing (**planned feature**)
Any of the above requests can trigger the KYC process,
