Merge pull request #80 from fingerprintjs/feat/update-schema-INTER-431

Add `highActivity` and `locationSpoofing` signals, support `originTimezone` for `vpn` signal
fingerprintjs · Nov 27, 2023 · 36a6258 · 36a6258
2 parents 48a70b0 + e35961c
commit 36a6258
Show file tree

Hide file tree

Showing 22 changed files with 1,548 additions and 109 deletions.
diff --git a/README.md b/README.md
@@ -175,6 +175,7 @@ Class | Method | HTTP request | Description
  - [ErrorEvent404ResponseError](docs/Model/ErrorEvent404ResponseError.md)
  - [ErrorVisits403](docs/Model/ErrorVisits403.md)
  - [EventResponse](docs/Model/EventResponse.md)
+ - [HighActivityResult](docs/Model/HighActivityResult.md)
  - [IPLocation](docs/Model/IPLocation.md)
  - [IPLocationCity](docs/Model/IPLocationCity.md)
  - [IdentificationError](docs/Model/IdentificationError.md)
@@ -184,6 +185,7 @@ Class | Method | HTTP request | Description
  - [IpInfoResultV4](docs/Model/IpInfoResultV4.md)
  - [IpInfoResultV6](docs/Model/IpInfoResultV6.md)
  - [Location](docs/Model/Location.md)
+ - [LocationSpoofingResult](docs/Model/LocationSpoofingResult.md)
  - [ManyRequestsResponse](docs/Model/ManyRequestsResponse.md)
  - [ProductError](docs/Model/ProductError.md)
  - [ProductsResponse](docs/Model/ProductsResponse.md)
@@ -202,12 +204,14 @@ Class | Method | HTTP request | Description
  - [SignalResponseFactoryResetData](docs/Model/SignalResponseFactoryResetData.md)
  - [SignalResponseFrida](docs/Model/SignalResponseFrida.md)
  - [SignalResponseFridaData](docs/Model/SignalResponseFridaData.md)
+ - [SignalResponseHighActivity](docs/Model/SignalResponseHighActivity.md)
  - [SignalResponseIncognito](docs/Model/SignalResponseIncognito.md)
  - [SignalResponseIncognitoData](docs/Model/SignalResponseIncognitoData.md)
  - [SignalResponseIpBlocklist](docs/Model/SignalResponseIpBlocklist.md)
  - [SignalResponseIpInfo](docs/Model/SignalResponseIpInfo.md)
  - [SignalResponseJailbroken](docs/Model/SignalResponseJailbroken.md)
  - [SignalResponseJailbrokenData](docs/Model/SignalResponseJailbrokenData.md)
+ - [SignalResponseLocationSpoofing](docs/Model/SignalResponseLocationSpoofing.md)
  - [SignalResponsePrivacySettings](docs/Model/SignalResponsePrivacySettings.md)
  - [SignalResponsePrivacySettingsData](docs/Model/SignalResponsePrivacySettingsData.md)
  - [SignalResponseProxy](docs/Model/SignalResponseProxy.md)

diff --git a/docs/Model/HighActivityResult.md b/docs/Model/HighActivityResult.md
@@ -0,0 +1,10 @@
+# HighActivityResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **bool** | Flag indicating whether the request came from a high activity visitor. | [optional] 
+**daily_requests** | **float** | Number of requests from the same visitor in the previous day. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/Model/IPLocation.md b/docs/Model/IPLocation.md
@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**accuracy_radius** | **int** |  | [optional] 
+**accuracy_radius** | **int** | The IP address is likely to be within this radius (in km) of the specified location. | [optional] 
 **latitude** | **double** |  | [optional] 
 **longitude** | **double** |  | [optional] 
 **postal_code** | **string** |  | [optional] 

diff --git a/docs/Model/LocationSpoofingResult.md b/docs/Model/LocationSpoofingResult.md
@@ -0,0 +1,9 @@
+# LocationSpoofingResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **bool** | Flag indicating whether the request came from a device with location spoofing enabled. | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/Model/ProductsResponse.md b/docs/Model/ProductsResponse.md
@@ -22,6 +22,8 @@ Name | Type | Description | Notes
 **vpn** | [**\Fingerprint\ServerAPI\Model\SignalResponseVpn**](SignalResponseVpn.md) |  | [optional] 
 **proxy** | [**\Fingerprint\ServerAPI\Model\SignalResponseProxy**](SignalResponseProxy.md) |  | [optional] 
 **tampering** | [**\Fingerprint\ServerAPI\Model\SignalResponseTampering**](SignalResponseTampering.md) |  | [optional] 
+**high_activity** | [**\Fingerprint\ServerAPI\Model\SignalResponseHighActivity**](SignalResponseHighActivity.md) |  | [optional] 
+**location_spoofing** | [**\Fingerprint\ServerAPI\Model\SignalResponseLocationSpoofing**](SignalResponseLocationSpoofing.md) |  | [optional] 
 **raw_device_attributes** | [**\Fingerprint\ServerAPI\Model\SignalResponseRawDeviceAttributes**](SignalResponseRawDeviceAttributes.md) |  | [optional] 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

diff --git a/docs/Model/ProductsResponseIdentificationData.md b/docs/Model/ProductsResponseIdentificationData.md
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
 **visitor_found** | **bool** | Attribute represents if a visitor had been identified before. | 
 **first_seen_at** | [**\Fingerprint\ServerAPI\Model\SeenAt**](SeenAt.md) |  | 
 **last_seen_at** | [**\Fingerprint\ServerAPI\Model\SeenAt**](SeenAt.md) |  | 
-**visitor_id** | **string** | String of 20 characters that uniquely identifies the visitor's browser.  **Pro Plus:** If a bot is detected (`products.botd.bot.result != \"notDetected\"`), the `visitorId` value contains a placeholder string `BotDetected000000000`. | 
+**visitor_id** | **string** | String of 20 characters that uniquely identifies the visitor's browser. | 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 
diff --git a/docs/Model/SignalResponseHighActivity.md b/docs/Model/SignalResponseHighActivity.md
@@ -0,0 +1,10 @@
+# SignalResponseHighActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\HighActivityResult**](HighActivityResult.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\ProductError**](ProductError.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/Model/SignalResponseLocationSpoofing.md b/docs/Model/SignalResponseLocationSpoofing.md
@@ -0,0 +1,10 @@
+# SignalResponseLocationSpoofing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**\Fingerprint\ServerAPI\Model\LocationSpoofingResult**](LocationSpoofingResult.md) |  | [optional] 
+**error** | [**\Fingerprint\ServerAPI\Model\ProductError**](ProductError.md) |  | [optional] 
+
+[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
+
diff --git a/docs/Model/VpnResult.md b/docs/Model/VpnResult.md
@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **result** | **bool** | VPN or other anonymizing service has been used when sending the request. | [optional] 
+**origin_timezone** | **string** | Local timezone which is used in timezoneMismatch method. | [optional] 
 **methods** | [**\Fingerprint\ServerAPI\Model\VpnResultMethods**](VpnResultMethods.md) |  | [optional] 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

diff --git a/docs/Model/WebhookVisit.md b/docs/Model/WebhookVisit.md
@@ -23,6 +23,8 @@ Name | Type | Description | Notes
 **proxy** | [**\Fingerprint\ServerAPI\Model\WebhookSignalResponseProxy**](WebhookSignalResponseProxy.md) |  | [optional] 
 **tampering** | [**\Fingerprint\ServerAPI\Model\TamperingResult**](TamperingResult.md) |  | [optional] 
 **raw_device_attributes** | [**\Fingerprint\ServerAPI\Model\RawDeviceAttributesResult**](RawDeviceAttributesResult.md) |  | [optional] 
+**high_activity** | [**\Fingerprint\ServerAPI\Model\HighActivityResult**](HighActivityResult.md) |  | [optional] 
+**location_spoofing** | [**\Fingerprint\ServerAPI\Model\LocationSpoofingResult**](LocationSpoofingResult.md) |  | [optional] 
 **request_id** | **string** | Unique identifier of the user's identification request. | 
 **browser_details** | [**\Fingerprint\ServerAPI\Model\BrowserDetails**](BrowserDetails.md) |  | 
 **ip** | **string** |  | 

diff --git a/res/fingerprint-server-api.yaml b/res/fingerprint-server-api.yaml
@@ -182,6 +182,7 @@ paths:
                       vpn:
                         data:
                           result: false
+                          originTimezone: Europe/Berlin
                           methods:
                             timezoneMismatch: false
                             publicVPN: false
@@ -231,106 +232,12 @@ paths:
                             value: 0
                           cookiesEnabled:
                             value: true
-                proPlusBotDetectedResponse:
-                  summary: Bot detected on Pro Plus plan
-                  value:
-                    products:
-                      identification:
-                        data:
-                          visitorId: BotDetected000000000
-                          requestId: 0KSh65EnVoB85JBmloQK
-                          incognito: true
-                          linkedId: somelinkedId
-                          time: '2019-05-21T16:40:13Z'
-                          timestamp: 1582299576512
-                          url: https://www.example.com/login
-                          ip: 61.127.217.15
-                          ipLocation: {}
-                          browserDetails:
-                            browserName: ''
-                            browserMajorVersion: ''
-                            browserFullVersion: ''
-                            os: ''
-                            osVersion: ''
-                            device: ''
-                            userAgent: Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....
-                          confidence:
-                            score: 0.5
-                            comment: The real score is unknown
-                          visitorFound: false
-                          firstSeenAt:
-                            global: null
-                            subscription: null
-                          lastSeenAt:
-                            global: null
-                            subscription: null
-                      botd:
-                        data:
-                          bot:
-                            result: bad
-                            type: selenium
-                          url: https://www.example.com/login
-                          ip: 61.127.217.15
-                          time: '2019-05-21T16:40:13Z'
-                      ipInfo:
-                        data:
-                          v4:
-                            address: 94.142.239.124
-                            geolocation:
-                              accuracyRadius: 20
-                              latitude: 50.05
-                              longitude: 14.4
-                              postalCode: 150 00
-                              timezone: Europe/Prague
-                              city:
-                                name: Prague
-                              country:
-                                code: CZ
-                                name: Czechia
-                              continent:
-                                code: EU
-                                name: Europe
-                              subdivisions:
-                                - isoCode: '10'
-                                  name: Hlavni mesto Praha
-                            asn:
-                              asn: '7922'
-                              name: COMCAST-7922
-                              network: 73.136.0.0/13
-                            dataCenter:
-                              result: true
-                              name: DediPath
-                      incognito:
-                        data:
-                          result: false
-                      rootApps:
-                        data:
-                          result: false
-                      emulator:
-                        data:
-                          result: false
-                      ipBlocklist:
+                      highActivity:
                         data:
                           result: false
-                          details:
-                            emailSpam: false
-                            attackSource: false
-                      tor:
+                      locationSpoofing:
                         data:
                           result: false
-                      vpn:
-                        data:
-                          result: false
-                          methods:
-                            timezoneMismatch: false
-                            publicVPN: false
-                      proxy:
-                        data:
-                          result: false
-                      tampering:
-                        data:
-                          result: false
-                          anomalyScore: 0
                 allErrorsResponse:
                   summary: All failed signals
                   value:
@@ -3810,6 +3717,7 @@ paths:
                           result: false
                         vpn:
                           result: false
+                          originTimezone: Europe/Berlin
                           methods:
                             timezoneMismatch: false
                             publicVPN: false
@@ -3850,6 +3758,10 @@ paths:
                             value: 0
                           cookiesEnabled:
                             value: true
+                        highActivity:
+                          result: false
+                        locationSpoofing:
+                          result: true
               responses:
                 default:
                   description: The server doesn't validate the answer.
@@ -4186,6 +4098,10 @@ components:
           $ref: '#/components/schemas/TamperingResult'
         rawDeviceAttributes:
           $ref: '#/components/schemas/RawDeviceAttributesResult'
+        highActivity:
+          $ref: '#/components/schemas/HighActivityResult'
+        locationSpoofing:
+          $ref: '#/components/schemas/LocationSpoofingResult'
         requestId:
           description: Unique identifier of the user's identification request.
           type: string
@@ -4421,6 +4337,9 @@ components:
       additionalProperties: false
       properties:
         accuracyRadius:
+          description: >-
+            The IP address is likely to be within this radius (in km) of the
+            specified location.
           type: integer
           minimum: 0
           example: 1000
@@ -4563,16 +4482,8 @@ components:
                   description: >
                     String of 20 characters that uniquely identifies the
                     visitor's browser.
-
-
-                    **Pro Plus:**
-
-                    If a bot is detected (`products.botd.bot.result !=
-                    "notDetected"`), the `visitorId` value contains a
-                    placeholder string `BotDetected000000000`.
                   example:
                     - Ibk1527CUFmcnjLwIs4A
-                    - BotDetected000000000
               additionalProperties: false
               required:
                 - browserDetails
@@ -4816,6 +4727,22 @@ components:
               $ref: '#/components/schemas/TamperingResult'
             error:
               $ref: '#/components/schemas/ProductError'
+        highActivity:
+          title: SignalResponseHighActivity
+          type: object
+          properties:
+            data:
+              $ref: '#/components/schemas/HighActivityResult'
+            error:
+              $ref: '#/components/schemas/ProductError'
+        locationSpoofing:
+          title: SignalResponseLocationSpoofing
+          type: object
+          properties:
+            data:
+              $ref: '#/components/schemas/LocationSpoofingResult'
+            error:
+              $ref: '#/components/schemas/ProductError'
         rawDeviceAttributes:
           title: SignalResponseRawDeviceAttributes
           type: object
@@ -4975,6 +4902,10 @@ components:
             VPN or other anonymizing service has been used when sending the
             request.
           example: false
+        originTimezone:
+          type: string
+          description: Local timezone which is used in timezoneMismatch method.
+          example: Europe/Berlin
         methods:
           type: object
           properties:
@@ -5014,6 +4945,29 @@ components:
           example: 0
           minimum: 0
           maximum: 1
+    HighActivityResult:
+      type: object
+      properties:
+        result:
+          type: boolean
+          description: >-
+            Flag indicating whether the request came from a high activity
+            visitor.
+          example: false
+        dailyRequests:
+          type: number
+          description: Number of requests from the same visitor in the previous day.
+          example: 10
+          minimum: 1
+    LocationSpoofingResult:
+      type: object
+      properties:
+        result:
+          type: boolean
+          description: >-
+            Flag indicating whether the request came from a device with location
+            spoofing enabled.
+          example: false
     RawDeviceAttributesResult:
       type: object
       description: >