@take2identity/verosint 0.2.199 → 0.2.201

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2025 Verosint, Inc <support@verosint.com> (https://verosint.com)
3
+ Copyright (c) 2026 Verosint, Inc <support@verosint.com> (https://verosint.com)
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -93,7 +93,7 @@ verosint evaluate rules-batch --help
93
93
 
94
94
  The tool can read settings from a configuration file in a
95
95
  [YAML](https://yaml.org/) format.
96
- For example, you can store the API key as well as rule sets inside the file.
96
+ For example, you can store the API key inside the file.
97
97
 
98
98
  By default, the tool looks for the configuration file `.verosint.yaml` in
99
99
  your home directory. You can override this setting with the
@@ -103,12 +103,6 @@ An example configuration file:
103
103
 
104
104
  ```yaml
105
105
  apiKey: <API key goes here>
106
- rules:
107
- - name: IP - Tor/Bot/VPN
108
- outcomes:
109
- - DENY
110
- query: 'signals.ip.bot || signals.ip.tor || signals.ip.vpn'
111
- reason: This IP address is a known bot, active Tor node, or a VPN
112
106
  ```
113
107
 
114
108
  #### API key as an Environment Variable
@@ -118,7 +112,7 @@ of the API key:
118
112
 
119
113
  ```shell
120
114
  export VEROSINT_APIKEY="API key goes here"
121
- verosint evaluate evaluate rule phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
115
+ verosint evaluate rules phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
122
116
  ```
123
117
 
124
118
  #### Account IDs
@@ -158,11 +152,11 @@ Responses are provided in the JSON format on the standard output.
158
152
  ###### 2. Evaluate an IPv6 address, a phone number and an email address for a Rule Set
159
153
 
160
154
  ```shell
161
- verosint evalute rule ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
155
+ verosint evaluate rules ip:2607:fb91:1296:c7dc:a0c4:25a9:ac7a:4384 email:user@example.com phone:15123944240 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
162
156
 
163
157
  ```
164
158
 
165
- ###### 3. Evaluate an IPv4 for address against a rule set already defined in the configuration
159
+ ###### 3. Evaluate an IPv4 address against a rule set
166
160
 
167
161
  To obtain the UUID of the rule set, visit the
168
162
  [Rule Sets](https://app.verosint.com/rule-sets) configuration and copy the UUID of
@@ -171,45 +165,7 @@ the rule set you would like to evaluate.
171
165
  ![Copy Rule Set UUID](assets/copyrulesetuuid.png)
172
166
 
173
167
  ```shell
174
- verosint evalute rule ip:104.255.6.45 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
175
- ```
176
-
177
- ###### 4. Evaluate an Email address against a rule set provided using a local file
178
-
179
- You can export a rule set defined in the [Rule Sets](https://app.verosint.com/rule-sets)
180
- configuration into a local file as shown below.
181
-
182
- ![Export Rule Set](assets/exportruleset.png)
183
-
184
- This example evaluates the `babs@jensen.com` email address against the rule defined
185
- in the `mfaruleset.json` file.
186
-
187
- ```shell
188
- verosint evaluate rule email:babs@jensen.com --ruleSetFile mfaruleset.json
189
- ```
190
-
191
- ##### 5. Check if an IP address is within 100 kilometers of Austin, TX using a local rule set
192
-
193
- You can place a rule set inside a local configuration file. The following is
194
- an example file that uses the `isWithin` function, which enables you to
195
- create a rule set for [geo-fencing](https://en.wikipedia.org/wiki/Geo-fence)
196
- purposes:
197
-
198
- ```yaml
199
- apiKey: <API key goes here>
200
- rules:
201
- - name: IP not in Austin
202
- outcomes:
203
- - DENY
204
- query: '!signals.ip.geo.isWithin(30.3079827, -97.895826, 100)'
205
- reason: This IP is not within 100 kilometers of Austin, Texas
206
- ```
207
-
208
- The following example runs the same rule set saved in the default
209
- configuration file against the `104.16.44.99` IP address:
210
-
211
- ```shell
212
- verosint evaluate rules ip:104.16.44.99
168
+ verosint evaluate rules ip:104.255.6.45 --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567
213
169
  ```
214
170
 
215
171
  #### Batch Evaluation
@@ -235,12 +191,12 @@ ipaddress,mail,telephone
235
191
  104.16.44.99,babs@jensen.com,15123944240
236
192
  ```
237
193
 
238
- Using the rule sets present in the default configuration file, the
239
- following command generates LDIF-formatted output and JSON report
240
- files:
194
+ The following command evaluates the identifiers against a rule set and
195
+ generates LDIF-formatted output and JSON report files:
241
196
 
242
197
  ```shell
243
198
  verosint evaluate rules-batch ip:0 email:1 phone:2 \
199
+ --ruleSetUuid 4f5ab21b-984c-455e-b889-b6b0272a4567 \
244
200
  --inputFile mapped.csv \
245
201
  --outputFile output.ldif --outputType ldif \
246
202
  --reportFile report.json
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@take2identity/verosint",
3
- "version": "0.2.199",
3
+ "version": "0.2.201",
4
4
  "description": "Official CLI to interact with Verosint API",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/postinstall.js CHANGED
@@ -1,5 +1,5 @@
1
1
  #!/usr/bin/env node
2
- // Copyright (c) "2025 Verosint, Inc"
2
+ // Copyright (c) "2026 Verosint, Inc"
3
3
  "use strict"
4
4
 
5
5
  const { join } = require('path');