commit 96d5f9774e48dfa26bb0382b612f8979358889ba
parent cda5ef99a686683b0991922f7949a9443c450dcf
Author: Vint Leenaars <vl.software@leenaa.rs>
Date: Fri, 9 May 2025 01:49:07 +0200
Organisation example in the README
Diffstat:
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
@@ -59,30 +59,32 @@ If you do not specify a path, the binary will be placed in `~/.local/bin` by def
~/.local/bin/kycheck --help
```
-You can either provide all the parameters on the command line, or use a configuration file (in [Dhall](https://dhall-lang.org/). There is an example configuration file called `kycheck.conf` available, with reasonably sane defaults.
+You can either provide all the parameters on the command line, or use a configuration file (in [Dhall](https://dhall-lang.org/). There is an example configuration file called `kycheck.conf` available, with reasonably sane defaults. You can specify your own using the flag `--config`.
-Start the application (we recommend using the more verbose option (using `--info`) until you've gained some experience with the tool), and wait until the data is loaded and the application indicates it is ready to receive your input. After that, you can paste in data about people and organisations you want to check against. Use jsonlines. E.g. if you paste:
+Start the application (we recommend using the more verbose option (using `--info`) until you've gained some experience with the tool), and wait until the data is loaded and the application indicates it is ready to receive your input. After that, you can paste in data about people and organisations you want to check against. Use jsonlines, one line per person or entity. E.g. if you paste:
```{"full_name" : "Maria Consuela", "last_name" : "", "address" : { "country" : "GT", "street_name" : "Unknown", "street_number" : "", "zipcode" : "" }, "birthdate" : "1953-06-23", "nationality" : "GT", "national_id" : "" }```
-kycheck will print:
+kycheck will print something like:
```Score {match_quality = 0.85357136, confidence = 0.9311688, expiration = 0, reference = 73508}```
-If there are multiple entries that match, kycheck will print these so you can investigate them.
+If there are multiple entries that match, kycheck will print all of them so you can investigate.
-You can also search for entities:
+Enter new lines with subject data until you've researched all.
+
+You can also check out legal entities. Using an example organisation from our tests (note that this is an example entity that is not on the sanction list, so we need to provide our own alternative 'sanction list':
```.local/bin/kycheck --config kycheck.example.conf --input test/data/target_1.xml```
+The input:
+
```{"company_name" : "Eindhoven University of Technology", "id" : "abcdef", "address" : { "country" : "NL", "street_name" : "Groene Loper", "street_number" : "3", "zipcode" : "5612 AE", "town_location" : "Eindhoven" } }```
-Will yield:
+Will yield this output:
```Score {match_quality = 0.90476197, confidence = 0.98701304, expiration = 0, reference = 1}```
-Enter new lines with subject data until you've researched all.
-
You can exit the application by typing the word 'quit' and pressing enter, or by pressing <ctrl> C.
## Testing
