TALER-EXCHANGE-KYC-TESTER(1)

📦 version 1.3.0, in nixos 26.05, nixpkgs unstable

💖 taler-exchange-kyc-tester — the group-chat guide ✨

okay bestie, so this is taler-exchange-kyc-tester from the GNU Taler manual, section 1 (commands, iykyk). it's the little tool that lets you poke at KYC stuff without setting anything on fire. let's get into it 🎀

🌸 NAME 🌸

taler-exchange-kyc-tester — literally just here to test KYC service integration. that's the whole vibe. 💅

🦋 SYNOPSIS 🦋

taler-exchange-kyc-tester [-c FILENAME | --config=FILENAME]
[-h | --help] [-L LOGLEVEL | --loglevel=LOGLEVEL]
[-l FILENAME | --logfile=FILENAME]
[-i SECTION_NAME | --initiate=SECTION_NAME] [-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]

copy it exactly, don't get creative with the flags, bestie 🫶

✨ DESCRIPTION ✨

so taler-exchange-kyc-tester is the tool for testing how a Taler exchange and a KYC service talk to each other. you can manually trigger the different steps of a KYC process and then just... watch 👀 the interaction with the KYC service go down. it exists to help you test the configuration of the integration — and it is supposted to be a testing thing only. it is not required at all during production, like genuinely, keep it out of prod, no cap. 💀

to actually use it, you first need to hand it a configuration file with at least one KYC service configured. some other exchange-specific options are required too, like the PORT for the HTTP service and the BASE_URL under which the Taler exchange will run. the cute part: you should be able to use exactly the same configuration file that you'd normally give to a Taler exchange. 🎀 from there, the tool lets you simulate a KYC process. important detail though — it will not write any information to the database. so you're free to play, nothing gets saved. 🙈

🌈 how the flow goes (the actual steps)

  1. start with a first invocation of taler-exchange-kyc-tester using the -i option for an individual or a business, and use -R to specify the list of checks required from the process. the output will be a URL to visit with your browser 🌐, plus the -p, -u, and -U options you'll need in future invocations of the tool.
  2. next, run taler-exchange-kyc-tester again — but this time use -w (to run the webservice) and use the -u and -U options that the previous call output, plus the -p option with the payto hash.
  3. then go visit the website from the link that the previous invocation output, and "pass" (or "fail") the KYC check. that's it, that's the whole ritual. ✨

💜 OPTIONS 💜

  • -c FILENAME, --config=FILENAME — use the configuration and other resources for the exchange to operate from FILENAME. 🗂️
  • -h, --help — print short help on options. the classic.
  • -L LOGLEVEL, --loglevel=LOGLEVEL — specifies the log level to use. accepted values are: DEBUG, INFO, WARNING, ERROR. pick your loudness. 🔥
  • -l FILENAME, --logfile=FILENAME — send logging output to FILENAME. keep the receipts. 🧾
  • -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". that's it, those are the two, don't try anything else. 👑
  • -M, --list-measures — list possible measures to be given to the -m option. window shopping before you commit. 🛍️
  • -m MEASURE_NAME, --measure=MEASURE_NAME — trigger the KYC operation using the given MEASURE_NAME, chosen from among the choices of KYC measures. 🎯
  • -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 you need that hash for a later use together with -p. 🖨️
  • -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 you don't give it, a fresh random value gets used. rarely useful, ngl. 🎲
  • -R CHECKS, --requirements=CHECKS — start a fresh KYC process for the given list of CHECKS. CHECKS must be a space-separated list of checks, and those checks 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, right there on the command line. this is usually the first thing to do when using this tool. it outputs the KYC-logic specific user and legitimization IDs, or NULL if not used by the KYC-logic at the initiation stage. and 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. (yes, 42. iconic.) 🌟
  • -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 as the legitimization process identifier at the KYC provider. not useful in conjunction with -R / -i, because that option will override whatever value you provide here. 🙃
  • -u ID, --user=ID — run the process with ID as the user identifier at the KYC provider. not useful in conjunction with -i and -R, as that option will override whatever value you provide here. same energy, different flag. 🫶
  • -v, --version — print version information.
  • -w, --run-webservice — run a simulated Taler exchange HTTP service on the configured port, with the /kyc-proof/ and /kyc-webhook/ endpoints. this is the main character step. 🕸️

🍓 SEE ALSO 🍓

go read those too, iykyk 💖

💀 BUGS 💀

found a bug? report bugs by using https://bugs.taler.net/ or by sending electronic mail to <taler@gnu.org>. they wanna hear it, fr fr. 🐛

🌸 AUTHOR 🌸

GNU Taler contributors — the collective. 👑

2014-2025 Taler Systems SA (GPLv3+ or GFDL 1.3+)

ok and that's the whole page bestie, no cap, every flag accounted for 💅

so yeah — that was 1.0, dated Dec 22, 2025, from the TALER-EXCHANGE-KYC-TESTER(1) page. go forth and test those KYC integrations, you absolute icon. 🌈✨🦋

📦 where this page comes from