taler-docs

commit cca8fbf884e698c1bef68ba05f4df0469f1bdf2f
parent a3aa3c84c2095a0288752318ad6a1950be16fcf9
Author: Christian Grothoff <christian@grothoff.org>
Date:   Tue, 16 Jul 2024 13:31:34 +0200

clarify API

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

1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/core/api-exchange.rst b/core/api-exchange.rst
@@ -1411,7 +1411,7 @@ and freeze or unfreeze accounts suspected of money laundering.
 
       // Map from IETF BCP 47 language tags to localized
       // description texts.
-      description_i18n: { [lang_tag: string]: string};
+      description_i18n ?: { [lang_tag: string]: string};
 
       // Names of the fields that the CONTEXT must provide
       // as inputs to this check.
@@ -1450,10 +1450,12 @@ and freeze or unfreeze accounts suspected of money laundering.
   :query start_date=TIMESTAMP:
     *Optional*. Specifies the date when to
     start looking (inclusive). If not given, the start time of the
-    exchange operation is used.
+    exchange operation is used.  The TIMESTAMP is given
+    in seconds since the UNIX epoch.
   :query end_date=TIMESTAMP:
     *Optional*. Specifies the date when to
-    stop looking (exclusive). If not given, the current date is used.
+    stop looking (exclusive). If not given, the current date is used.  The TIMESTAMP is given
+    in seconds since the UNIX epoch.
 
   **Response:**
 
@@ -5401,8 +5403,9 @@ regulatory compliance.
   The ``/kyc-upload/$ID`` POST endpoint allows the SPA to upload
   client-provided evidence.  The ``$ID`` will be provided as part of the
   ``/kyc-info`` body.  This is for checks of type ``FORM``.  In practice,
-  ``$ID`` will encode both the ``$ACCESS_TOKEN`` and the index of the selected
-  measure (but this should be irrelevant for the client).
+  ``$ID`` will encode the ``$ACCESS_TOKEN``, legitimization measure serial ID
+  (to disambiguate) and the index of the selected measure (but these details
+  should be irrelevant for the client).
 
   This endpoint was introduced in protocol **v20**.
 
@@ -5430,8 +5433,9 @@ regulatory compliance.
   KYC process. It will return the URL that the client must GET to begin the
   KYC process. The SPA should probably open this URL in a new window or tab.
   The ``$ID`` will be provided as part of the ``/kyc-info`` body.  In
-  practice, ``$ID`` will encode both the ``$ACCESS_TOKEN`` and the index of
-  the selected measure (but this should be irrelevant for the client).
+  practice, ``$ID`` will encode the ``$ACCESS_TOKEN``, legitimization measure
+  serial ID (to disambiguate) and the index of the selected measure (but these
+  details should be irrelevant for the client).
 
   **Request:**