taler-docs

commit 41b07cfe98b8b751a5db98f3e4101ce021779f39
parent 3c2346736e05f4555a6b67730fa2862fbe2bdc94
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sun,  5 May 2024 11:09:13 +0200

update KYC spec

Diffstat:
M
design-documents/023-taler-kyc.rst
 | 
40
++++++++++++++++++++++++++++++++++------

1 file changed, 34 insertions(+), 6 deletions(-)
diff --git a/design-documents/023-taler-kyc.rst b/design-documents/023-taler-kyc.rst
@@ -716,6 +716,9 @@ New endpoints
       // description texts.
       description_i18n ?: { [lang_tag: string]: string };
 
+      // FIXME: is the above in any way sufficient
+      // to begin the check? Do we not need at least
+      // something more??!?
     }
 
   :http:statuscode:`204 No Content`:
@@ -1123,7 +1126,7 @@ New endpoints
     interface AmlDecisions {
 
       // Array of AML decisions matching the query.
-      records: AmlDecisions[];
+      records: AmlRecord[];
     }
 
   .. ts:def:: AmlRecord
@@ -1137,7 +1140,29 @@ New endpoints
       // Row ID of the record.  Used to filter by offset.
       rowid: Integer;
 
-      // FIXME: more fields here!
+      // When was the decision made?
+      decision_time: Timestamp;
+
+      // When does the decision expire?
+      expiration_time: Timestamp;
+
+      // Free-form properties about the account.
+      // Can be used to store properties such as PEP,
+      // risk category, type of business, hits on
+      // sanctions lists, etc.
+      properties?: AccountProperties;
+
+      // What are the new rules?
+      limits: LegitimizationRuleSet;
+
+      // True if the account is under investigation by AML staff
+      // after this decision.
+      to_investigate: bool;
+
+      // True if this is the active decision for the
+      // account.
+      is_active: bool;
+
     }
 
 
@@ -1209,7 +1234,7 @@ New endpoints
     }
 
 
-  .. http:post:: /aml/$OFFICER_PUB/decision
+.. http:post:: /aml/$OFFICER_PUB/decision
 
   Make an AML decision. Triggers the respective action and
   records the justification.
@@ -1248,7 +1273,7 @@ New endpoints
       new_rules: LegitimizationRuleSet;
 
       // True if the account should remain under investigation by AML staff.
-      bool keep_investigating;
+      keep_investigating: bool;
 
       // When was the decision made?
       decision_time: Timestamp;
@@ -1381,7 +1406,7 @@ providers, one per configuration section:
   DESCRIPTION_I18N = "{"en":"Upload scan of your passport"}"
 
   # ';'-separated list of fields that the CONTEXT must
-  # provided as inputs to this check. For example,
+  # provide as inputs to this check. For example,
   # for a FORM of type CHOICE, this might state
   # ``choices: string[];``. The type after the ":"
   # is for now purely for documentation and is
@@ -1391,8 +1416,11 @@ providers, one per configuration section:
 
   # Description of the outputs provided by the check.
   # Basically, the check's output is expected to
-  # provide the following fields as inputs into
+  # provide the following fields as attribute inputs into
   # a subsequent AML program.
+  # Only given for type FORM; INFO never has any outputs,
+  # and for type LINK we can obtain the same information
+  # from the CONVERTER via ``--list-outputs``.
   OUTPUTS = business_name street city country registration
 
   # **original** measure to take if the check fails