taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

robocop.1.rst (1407B)


      1 robocop(1)
      2 ##########
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **robocop** - find best matching sanction list entry
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **robocop**
     16 [**-h**_|_**--help**]
     17 [**-v**_|_**--version**]
     18 -- SANCTIONSLIST
     19 
     20 Description
     21 ===========
     22 
     23 **robocop** matches KYC and KYB data against a sanctionslist.
     24 The sanctionslist must be given as the only argument. It must
     25 be a JSON file with an array of objects where each object
     26 must have an "ssid" entry that identifies the sanction list
     27 record. Furthermore, each object may have any number of
     28 keys matching the Taler attribute registry which must be
     29 mapped to an array of strings representing values to match
     30 against.
     31 
     32 Robocop will then read JSON objects line-by-line from standard
     33 input. Each line must contain exactly one JSON object. Each
     34 JSON object must again consist of a set of attribute registry
     35 entries and their string values. For each JSON object read,
     36 Robocop will find the best matching sanction list entry and
     37 output the matching and confidence scores (on a scale of 0-1)
     38 and the "ssid" (one one line per input).
     39 
     40 The main use of Robocop is as a RATER tool for
     41 taler-exchange-sanctionscheck.
     42 
     43 Its options are as follows:
     44 
     45 **-h**
     46    Print short help on options.
     47 
     48 **-v**
     49    Print version number.
     50 
     51 See Also
     52 ========
     53 
     54 taler-exchange-sanctionscheck(1)
     55 
     56 Bugs
     57 ====
     58 
     59 Report bugs by using https://bugs.taler.net or by sending electronic
     60 mail to <taler@gnu.org>.