@take2identity/verosint 0.2.36 → 0.2.38

package/README.md

@@ -14,16 +14,10 @@
 ## Installation
 
 Use the `verosint` tool to:
-
-* Evaluate risk scores or create a rule set for a single set of identifiers
-(email, IP, and/or phone number).
-* Determine risk by running a batch evaluation for identifiers using a
-[CSV](https://en.wikipedia.org/wiki/Comma-separated_values),
-[LDIF](https://www.rfc-editor.org/rfc/rfc2849.html) files.
+* Tag account's using the SignalPrint tagging endpoint to distinguish identities
 * Send events to the SignalPrint endpoint to create a map of identities and access history.
 * Generate an [LDAP Schema](https://www.rfc-editor.org/rfc/rfc4512#page-22)
-file to store risk scoring and/or rules evaluation atttributes in user
-entries.
+file to store rules evaluation atttributes in user entries.
 
 Download the binary from:
 [releases page](https://gitlab.com/verosint/public/verosint/-/releases).
@@ -123,10 +117,10 @@ of the API key:
 
 ```shell
 export VEROSINT_APIKEY="API key goes here"
-verosint evaluate risk ip:172.66.43.186
+verosint evaluate evaluate rule phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 ```
 
-### Evaluating Risk or Rules
+### Evaluating Rules
 
 #### Single Set of Identifiers
 
@@ -140,8 +134,6 @@ The CLI accepts the following identifiers.
 | phone | Phone number in the [international phone number format](https://en.wikipedia.org/wiki/E.164) |
 | userAgent | User agent string |
 
-Note that `accountId` and `userAgent` identifiers are not available for risk score requests.
-
 When providing a set of identifiers, the API expects one or more
 identifiers (IP address, email, or phone number) and only one value per
 identifier.
@@ -153,16 +145,11 @@ Responses are provided in the JSON format on the standard output.
 
 ##### Examples
 
-###### 1. Evaluate an IPv4 address for risk
+###### 2. Evaluate an IPv6 address, a phone number and an email address for a Rules Set
 
 ```shell
-verosint evaluate risk ip:172.66.43.186
-```
-
-###### 2. Evaluate an IPv6 address, a phone number and an email address for risk
+verosint evalute rule ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
 
-```shell
-verosint evaluate risk ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240
 ```
 
 ###### 3. Evaluate an IPv4 for address against a rule set already defined in the configuration
@@ -217,8 +204,8 @@ verosint evaluate rules ip:104.16.44.99
 
 #### Batch Evaluation
 
-Use input files to evaluate multiple sets of identifiers for risk or
-against rules. Batch commands can use input and output files in CSV or
+Use input files to evaluate multiple sets of identifiers against rules. 
+Batch commands can use input and output files in CSV or
 LDIF format, and can produce a report file formatted as JSON.
 
 Processing time may take much longer with larger files, than for a
@@ -226,26 +213,6 @@ single set of identifiers.
 
 ##### Batch Evaluation Examples
 
-###### 1. Executing Batch Risk Evaluation using CSV input/output format
-
-The input file does not have to be fully populated for all identifiers.
-For example, the following CSV-formatted input file is valid without a
-phone number present on the last record:
-
-```csv
-ip,email,phone
-104.16.44.99,babs@jensen.com,15123944240
-2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384,alison@example.com,
-```
-
-To evaluate the same file and save it as `myRecords.csv`, run the
-following command:
-
-```shell
-verosint evaluate risk-batch --inputFile myRecords.csv \
-  --outputFile riskOutput.csv --reportFile riskReport.json
-```
-
 ###### 2. Executing Batch Rules Evaluation with column index and LDIF output
 
 If using an input file that has multiple identifiers, you can provide a
@@ -273,7 +240,7 @@ verosint evaluate rules-batch ip:0 email:1 phone:2 \
 
 You can submit events to the SignalPrint endpoint using the
 `signalprint send-events` subcommand. This subcommand works like the
-batch commands for risk and rules. An event timestamp, IP address, and
+batch commands for rules. An event timestamp, IP address, and
 user agent is required for each event. You can optionally add an
 accountId, email, type, and/or phone with each event.
 
@@ -302,7 +269,7 @@ verosint signalprint send-events --inputFile events.csv
 ### Generating LDAP Schema
 
 This command prints an LDAP schema that allows you to enrich existing
-user entries in your directory with risk or rule evaluation data from
+user entries in your directory with rule evaluation data from
 the API. The enterprise number (59592) in the object identifiers (OIDs)
 is registered with the
 [Internet Assigned Numbers Authority](https://www.iana.org/assignments/enterprise-numbers/).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@take2identity/verosint",
-  "version": "0.2.36",
+  "version": "0.2.38",
   "description": "Official CLI to interact with Verosint API",
   "main": "index.js",
   "scripts": {