taler-docs

commit 5b02803a90f624a12d562fa3cd284b1cd1ffe597
parent 12f631d5eb75bd406893ea63415987f44fa3321f
Author: Christian Grothoff <grothoff@gnunet.org>
Date:   Mon,  4 Aug 2025 17:37:58 +0200

add phone_number and address validation states to instances"

Diffstat:
M
core/api-merchant.rst
 | 
48
++++++++++++++++++++++++++----------------------

1 file changed, 26 insertions(+), 22 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -144,7 +144,7 @@ such as the implemented version of the protocol and the currency used.
 .. http:get:: /config
 
   Return the protocol version and currency supported by this merchant backend.
-  This specification corresponds to ``current`` protocol being version **v20**.
+  This specification corresponds to ``current`` protocol being version **v21**.
 
   **Response:**
 
@@ -1107,14 +1107,13 @@ Setting up instances
       // Merchant name corresponding to this instance.
       name: string;
 
-      // Type of the user (business or individual).
-      // Defaults to 'business'. Should become mandatory field
-      // in the future, left as optional for API compatibility for now.
-      user_type?: string;
-
-      // Merchant email for customer contact.
+      // Merchant email for customer contact and password reset.
       email?: string;
 
+      // Merchant phone number for password reset (2-FA)
+      // @since **v21**.
+      phone_number?: string;
+
       // Merchant public website.
       website?: string;
 
@@ -1403,14 +1402,13 @@ Setting up instances
       // Merchant name corresponding to this instance.
       name: string;
 
-      // Type of the user (business or individual).
-      // Defaults to 'business'. Should become mandatory field
-      // in the future, left as optional for API compatibility for now.
-      user_type?: string;
-
-      // Merchant email for customer contact.
+      // Merchant email for customer contact and password reset.
       email?: string;
 
+      // Merchant phone number for password reset (2-FA)
+      // @since **v21**.
+      phone_number?: string;
+
       // Merchant public website.
       website?: string;
 
@@ -1478,9 +1476,6 @@ Inspecting instances
       // Merchant name corresponding to this instance.
       name: string;
 
-      // Type of the user ("business" or "individual").
-      user_type: string;
-
       // Merchant public website.
       website?: string;
 
@@ -1528,12 +1523,21 @@ Inspecting instances
       // Merchant name corresponding to this instance.
       name: string;
 
-      // Type of the user ("business" or "individual").
-      user_type: string;
-
-      // Merchant email for customer contact.
+      // Merchant email for customer contact and password reset.
       email?: string;
 
+      // True if the ``email`` address was validated.
+      // @since **v21**.
+      email_validated?: bool;
+
+      // Merchant phone number for password reset (2-FA)
+      // @since **v21**.
+      phone_number?: string;
+
+      // True if the ``email`` address was validated.
+      // @since **v21**.
+      phone_validated?: bool;
+
       // Merchant public website.
       website?: string;
 
@@ -4747,7 +4751,7 @@ Creating token families
       // Offset to subtract from the start time rounded to ``validity_granularity``
       // to compute the actual start time for a key.
       // Default is zero. 
-      start_offset?: RelativeTime;
+      start_offset: RelativeTime;
 
       // Kind of the token family.
       kind: TokenFamilyKind;
@@ -5395,7 +5399,7 @@ It has the following structure:
     // The merchant's legal name of business.
     name: string;
 
-    // Label for a location with the business address of the merchant.
+    // Email address for contacting the merchant.
     email?: string;
 
     // Label for a location with the business address of the merchant.