commit d25e142db980b0dffbe5ec27d3edd3be02dd4e5a
parent c8e9fd65dc950ec7396f97504ffa5566a08698bc
Author: Christian Grothoff <christian@grothoff.org>
Date: Sat, 20 Jul 2024 16:31:55 +0200
update taler-exchange-kyc-tester man page
Diffstat:
1 file changed, 26 insertions(+), 10 deletions(-)
diff --git a/manpages/taler-exchange-kyc-tester.1.rst b/manpages/taler-exchange-kyc-tester.1.rst
@@ -17,11 +17,16 @@ Synopsis
[**-L** *LOGLEVEL* | **--loglevel=**\ \ *LOGLEVEL*]
[**-l** *FILENAME* | **--logfile=**\ \ *FILENAME*]
[**-i** *SECTION_NAME* | **--initiate=**\ \ *SECTION_NAME*]
-[**-u** *ID* | **--user=**\ \ *ID*]
-[**-U** *ID* | **--legitimization=**\ \ *ID*]
+[**-M** | **--list-measures**]
+[**-m** *MEASURE_NAME* | **--measure=**\ \ *MEASURE_NAME*]
+[**-o** *OPERATION_TYPE* | **--operation=**\ \ *OPERATION_TYPE*]
[**-P** | **--print-payto-hash**]
[**-p** *HASH* | **--payto-hash=**\ \ *HASH*]
+[**-R** *JSON* | **--ruleset=**\ \ *JSON*]
[**-r** *NUMBER* | **--rowid=**\ \ *NUMBER*]
+[**-t** *AMOUNT* | **--trigger=**\ \ *AMOUNT*]
+[**-u** *ID* | **--user=**\ \ *ID*]
+[**-U** *ID* | **--legitimization=**\ \ *ID*]
[**-v** | **--version**]
[**-w** | **--run-webservice**]
@@ -55,24 +60,35 @@ Next, run taler-exchange-kyc-tester again, but this time using **-w** (to run th
**-i** *USERTYPE* \| **--initiate=**\ \ *USERTYPE*
Specifies the type of user for which we are starting a fresh KYC process. USERTYPE must be either "individual" or "business".
-**-u** *ID* \| **--user=**\ \ *ID*
- Run the process with ID for the user identifier at the KYC provider. Not useful in conjunction with **-i** and **-R** as that option will override whatever value is provided here.
+**-M** \| **--list-measures**
+ List possible measures to be given to the **-m** option.
-**-U** *ID* \| **--legitimization=**\ \ *ID*
- Run the process with ID for the legitimization process identifier at the KYC provider. Not useful in conjunction with **-R** / **-i** as that option will override whatever value is provided here.
+**-m** *MEASURE_NAME* \| **--measure=**\ \ *MEASURE_NAME*
+ Trigger the KYC operation using the given *MEASURE_NAME* among the choices of KYC measures.
-**-p** *HASH* \| **--payto-hash=**\ \ *HASH*
- Run the process with HASH as the hash of the payto://-URI that identifies the account or wallet triggering the KYC requirement. If not given, a fresh random value is used. Rarely useful.
+**-o** *OPERATION_TYPE* \| **--operation=**\ \ *OPERATION_TYPE*
+ Trigger the KYC operation by simulating a trigger of the given *OPERATION_TYPE*.
**-P** \| **--print-payto-hash**
Print the HASH of the payto://-URI used for the KYC simulation this time. Useful if the hash is needed for a subsequent use in conjunction with **-p**.
-**-r** *NUMBER* \| **--rowid=**\ \ *NUMBER*
- Run the process with NUMBER as the database row for the legitimization operation. Rarely useful, except maybe for debugging. Defaults to 42.
+**-p** *HASH* \| **--payto-hash=**\ \ *HASH*
+ Run the process with HASH as the hash of the payto://-URI that identifies the account or wallet triggering the KYC requirement. If not given, a fresh random value is used. Rarely useful.
**-R** *CHECKS* \| **--requirements=**\ \ *CHECKS*
Start a fresh KYC process for the given list of CHECKS. CHECKS must be a space-separated list of checks that must be in the configuration under *PROVIDED_CHECKS* for some of the providers. The exchange will determine which provider to use for KYC based on the CHECKS given. The tool will output the HTTP URL where the user has to begin the KYC process to the command-line. This is usually the first thing to do when using this tool. Outputs the KYC-logic specific user and legitimization IDs, or NULL if not used by the KYC-logic at the initiation stage. You may want to use the **-P** option to also obtain the Payto-Hash for use with **p** later.
+**-r** *NUMBER* \| **--rowid=**\ \ *NUMBER*
+ Run the process with NUMBER as the database row for the legitimization operation. Rarely useful, except maybe for debugging. Defaults to 42.
+
+**-t** *AMOUNT* \| **--trigger=**\ \ *AMOUNT*
+ Trigger the KYC operation by crossing the specified *AMOUNT* for the given **-o** *OPERATION_TYPE*.
+
+**-U** *ID* \| **--legitimization=**\ \ *ID*
+ Run the process with ID for the legitimization process identifier at the KYC provider. Not useful in conjunction with **-R** / **-i** as that option will override whatever value is provided here.
+
+**-u** *ID* \| **--user=**\ \ *ID*
+ Run the process with ID for the user identifier at the KYC provider. Not useful in conjunction with **-i** and **-R** as that option will override whatever value is provided here.
**-v** \| **--version**
Print version information.
