taler-docs

commit b7642777240f6aa3c423b9f5cfd10e324f716859
parent 4d3bde413b86be30de56f71e7dd29ed109e988f4
Author: Christian Grothoff <christian@grothoff.org>
Date:   Wed,  9 Apr 2025 11:36:15 +0200

fix #9711: enable KYC link in SMS messages (challenger protocol v5)

Diffstat:
M
core/api-challenger.rst
 | 
37
+++++++++++++++++++++++++++++--------

1 file changed, 29 insertions(+), 8 deletions(-)
diff --git a/core/api-challenger.rst b/core/api-challenger.rst
@@ -101,7 +101,7 @@ Receiving Configuration
 .. http:get:: /config
 
   Obtain the key configuration settings of the storage service.
-  This specification corresponds to ``current`` protocol being version **4**.
+  This specification corresponds to ``current`` protocol being version **5**.
 
   **Response:**
 
@@ -289,13 +289,6 @@ Challenge
 
   :http:statuscode:`200 OK`:
     The response is `ChallengeResponse`. Since protocol **v2**.
-  :http:statuscode:`302 Found`:
-    Only possible if request didn't ask for application/json. Since protocol **v2**.
-    The user is redirected to the redirect URI of the client to pass the
-    grant to the client.  The target will be the redirect URI specified
-    by the client (during registration and again upon ``/authorize``),
-    plus a ``code`` argument with the authorization code, and the
-    ``state`` argument from the ``/authorize`` endpoint.
   :http:statuscode:`400 Bad Request`:
     The request does not follow the spec.
     The response will include error
@@ -365,6 +358,34 @@ Challenge
 
 
 
+.. http:get:: /challenge/$NONCE
+
+  This endpoint is used when a user clicks on a link in their challenge
+  message. It re-opens the same form as the one returned by the
+  POST request to the same endpoint. The main difference is that it
+  will never change the address and also never actually send the PIN.
+  Since protocol **v5**.
+
+  **Response:**
+
+  :http:statuscode:`200 OK`:
+    The response is `ChallengeResponse`. 
+  :http:statuscode:`400 Bad Request`:
+    The request does not follow the spec.
+    The response will include error
+    code, hint and detail.
+  :http:statuscode:`404 Not Found`:
+    The service is unaware of a matching challenge.
+    The response will include error
+    code, hint and detail.
+  :http:statuscode:`406 Not Acceptable`:
+    The client ask for "text/html" and the backend installation does
+    not include the required HTML templates.
+  :http:statuscode:`500 Internal Server Error`:
+    Server is not able to respond due to internal problems.
+    The response will include error
+    code, hint and detail.
+
 .. _challenger-solve:
 
 -----