@fingerprintjs/fingerprintjs-pro-server-api - npm Package Compare versions

Comparing version 3.1.0 to 4.0.0

package.json

 {
   "name": "@fingerprintjs/fingerprintjs-pro-server-api",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Node.js wrapper for FingerprintJS Sever API",
@@ -5,0 +5,0 @@ "main": "dist/index.cjs",

src/generatedApiTypes.ts

@@ -9,4 +9,5 @@ /**
     /**
-     * This endpoint allows you to get a detailed analysis of an individual request.
-     * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+     * Get event by requestId
+     * @description This endpoint allows you to get a detailed analysis of an individual request.
+     * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform.
      * It is highly recommended that you **ignore** the mobile signals for such requests.
@@ -20,3 +21,4 @@ *
     /**
-     * This endpoint allows you to get a history of visits for a specific `visitorId`. Use the `visitorId` as a URL path parameter.
+     * Get visits by visitorId
+     * @description This endpoint allows you to get a history of visits for a specific `visitorId`. Use the `visitorId` as a URL path parameter.
      * Only information from the _Identification_ product is returned.
@@ -31,7 +33,9 @@ *
   '/webhook': {
-    /** Fake path to describe webhook format. More information about webhooks can be found in the [documentation](https://dev.fingerprint.com/docs/webhooks) */
+    /** @description Fake path to describe webhook format. More information about webhooks can be found in the [documentation](https://dev.fingerprint.com/docs/webhooks) */
     trace: {
       responses: {
-        /** Dummy for the schema */
-        default: unknown;
+        /** @description Dummy for the schema */
+        default: {
+          content: never;
+        };
       };
@@ -42,2 +46,4 @@ };
 
+export type webhooks = Record<string, never>;
+
 export interface components {
@@ -65,4 +71,26 @@ schemas: {
         ip: string;
-        ipLocation?: components['schemas']['IPLocation'];
         /**
+         * DeprecatedIPLocation
+         * @deprecated
+         * @description This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
+         */
+        ipLocation?: {
+          /** @description The IP address is likely to be within this radius (in km) of the specified location. */
+          accuracyRadius?: number;
+          /** Format: double */
+          latitude?: number;
+          /** Format: double */
+          longitude?: number;
+          postalCode?: string;
+          /** Format: timezone */
+          timezone?: string;
+          /** DeprecatedIPLocationCity */
+          city?: {
+            name?: string;
+          };
+          country?: components['schemas']['Location'];
+          continent?: components['schemas']['Location'];
+          subdivisions?: components['schemas']['Subdivision'][];
+        };
+        /**
          * Format: int64
@@ -81,4 +109,3 @@ * @description Timestamp of the event with millisecond precision in Unix time.
         /**
-         * Format: uri
-         * @description Page URL from which identification request was sent.
+         * @description Page URL from which the identification request was sent.
          * @example https://some.website/path?query=params
@@ -88,3 +115,5 @@ */
         /** @description A customer-provided value or an object that was sent with identification request. */
-        tag: { [key: string]: unknown };
+        tag: {
+          [key: string]: unknown;
+        };
         /**
@@ -95,3 +124,3 @@ * @description A customer-provided id that was sent with identification request.
         linkedId?: string;
-        confidence: components['schemas']['Confidence'];
+        confidence?: components['schemas']['Confidence'];
         /** @description Attribute represents if a visitor had been identified before. */
@@ -173,102 +202,14 @@ visitorFound: boolean;
       incognito: boolean;
-      /** WebhookSignalResponseRootApps */
-      rootApps?: {
-        /**
-         * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client isn't Android.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
-      /** WebhookSignalResponseEmulator */
-      emulator?: {
-        /**
-         * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client isn't Android.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
-      /** WebhookSignalResponseClonedApp */
-      clonedApp?: {
-        /**
-         * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
-      /** WebhookSignalResponseFactoryReset */
-      factoryReset?: {
-        /**
-         * Time
-         * Format: date-time
-         * @description Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
-         *
-         * @example 2022-06-09T22:58:36Z
-         */
-        time?: string;
-        /**
-         * Format: int64
-         * @description Same value as it's in the `time` field but represented in timestamp format.
-         * @example 1654815517198
-         */
-        timestamp?: number;
-      };
-      /** WebhookSignalResponseJailbroken */
-      jailbroken?: {
-        /**
-         * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
-      /** WebhookSignalResponseFrida */
-      frida?: {
-        /**
-         * @description iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
+      rootApps?: components['schemas']['RootAppsResult'];
+      emulator?: components['schemas']['EmulatorResult'];
+      clonedApp?: components['schemas']['ClonedAppResult'];
+      factoryReset?: components['schemas']['FactoryResetResult'];
+      jailbroken?: components['schemas']['JailbrokenResult'];
+      frida?: components['schemas']['FridaResult'];
       ipBlocklist?: components['schemas']['IpBlockListResult'];
-      /** WebhookSignalResponseTor */
-      tor?: {
-        /**
-         * @description `true` if the request IP address is a known tor exit node, `false` otherwise.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
-      /** WebhookSignalResponsePrivacySettings */
-      privacySettings?: {
-        /**
-         * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
-      /** WebhookSignalResponseVirtualMachine */
-      virtualMachine?: {
-        /**
-         * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
+      tor?: components['schemas']['TorResult'];
+      privacySettings?: components['schemas']['PrivacySettingsResult'];
+      virtualMachine?: components['schemas']['VirtualMachineResult'];
       vpn?: components['schemas']['VpnResult'];
-      /** WebhookSignalResponseProxy */
-      proxy?: {
-        /**
-         * @description `true` if the request IP address is used by a public proxy provider, `false` otherwise.
-         *
-         * @example false
-         */
-        result?: boolean;
-      };
+      proxy?: components['schemas']['ProxyResult'];
       tampering?: components['schemas']['TamperingResult'];
@@ -278,2 +219,3 @@ rawDeviceAttributes?: components['schemas']['RawDeviceAttributesResult'];
       locationSpoofing?: components['schemas']['LocationSpoofingResult'];
+      suspectScore?: components['schemas']['SuspectScoreResult'];
       /**
@@ -290,4 +232,26 @@ * @description Unique identifier of the user's identification request.
       ip: string;
-      ipLocation?: components['schemas']['IPLocation'];
       /**
+       * DeprecatedIPLocation
+       * @deprecated
+       * @description This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
+       */
+      ipLocation?: {
+        /** @description The IP address is likely to be within this radius (in km) of the specified location. */
+        accuracyRadius?: number;
+        /** Format: double */
+        latitude?: number;
+        /** Format: double */
+        longitude?: number;
+        postalCode?: string;
+        /** Format: timezone */
+        timezone?: string;
+        /** DeprecatedIPLocationCity */
+        city?: {
+          name?: string;
+        };
+        country?: components['schemas']['Location'];
+        continent?: components['schemas']['Location'];
+        subdivisions?: components['schemas']['Subdivision'][];
+      };
+      /**
        * Format: int64
@@ -306,4 +270,3 @@ * @description Timestamp of the event with millisecond precision in Unix time.
       /**
-       * Format: uri
-       * @description Page URL from which identification request was sent.
+       * @description Page URL from which the identification request was sent.
        * @example https://some.website/path?query=params
@@ -313,3 +276,5 @@ */
       /** @description A customer-provided value or an object that was sent with identification request. */
-      tag?: { [key: string]: unknown };
+      tag: {
+        [key: string]: unknown;
+      };
       /**
@@ -320,3 +285,3 @@ * @description A customer-provided id that was sent with identification request.
       linkedId?: string;
-      confidence: components['schemas']['Confidence'];
+      confidence?: components['schemas']['Confidence'];
       /** @description Attribute represents if a visitor had been identified before. */
@@ -342,4 +307,26 @@ visitorFound: boolean;
       ip: string;
-      ipLocation?: components['schemas']['IPLocation'];
       /**
+       * DeprecatedIPLocation
+       * @deprecated
+       * @description This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
+       */
+      ipLocation?: {
+        /** @description The IP address is likely to be within this radius (in km) of the specified location. */
+        accuracyRadius?: number;
+        /** Format: double */
+        latitude?: number;
+        /** Format: double */
+        longitude?: number;
+        postalCode?: string;
+        /** Format: timezone */
+        timezone?: string;
+        /** DeprecatedIPLocationCity */
+        city?: {
+          name?: string;
+        };
+        country?: components['schemas']['Location'];
+        continent?: components['schemas']['Location'];
+        subdivisions?: components['schemas']['Subdivision'][];
+      };
+      /**
        * Format: int64
@@ -358,4 +345,3 @@ * @description Timestamp of the event with millisecond precision in Unix time.
       /**
-       * Format: uri
-       * @description Page URL from which identification request was sent.
+       * @description Page URL from which the identification request was sent.
        * @example https://some.website/path?query=params
@@ -365,3 +351,5 @@ */
       /** @description A customer-provided value or an object that was sent with identification request. */
-      tag?: { [key: string]: unknown };
+      tag: {
+        [key: string]: unknown;
+      };
       /**
@@ -372,3 +360,3 @@ * @description A customer-provided id that was sent with identification request.
       linkedId?: string;
-      confidence: components['schemas']['Confidence'];
+      confidence?: components['schemas']['Confidence'];
       /** @description Attribute represents if a visitor had been identified before. */
@@ -439,7 +427,3 @@ visitorFound: boolean;
     };
-    /**
-     * IPLocation
-     * @deprecated
-     * @description This field is **deprecated** and will not return a result for **accounts created after December 18th, 2023**. Please use the [`ipInfo` Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
-     */
+    /** IPLocation */
     IPLocation: {
@@ -509,4 +493,26 @@ /**
           ip: string;
-          ipLocation?: components['schemas']['IPLocation'];
           /**
+           * DeprecatedIPLocation
+           * @deprecated
+           * @description This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information.
+           */
+          ipLocation?: {
+            /** @description The IP address is likely to be within this radius (in km) of the specified location. */
+            accuracyRadius?: number;
+            /** Format: double */
+            latitude?: number;
+            /** Format: double */
+            longitude?: number;
+            postalCode?: string;
+            /** Format: timezone */
+            timezone?: string;
+            /** DeprecatedIPLocationCity */
+            city?: {
+              name?: string;
+            };
+            country?: components['schemas']['Location'];
+            continent?: components['schemas']['Location'];
+            subdivisions?: components['schemas']['Subdivision'][];
+          };
+          /**
            * Format: int64
@@ -525,4 +531,3 @@ * @description Timestamp of the event with millisecond precision in Unix time.
           /**
-           * Format: uri
-           * @description Page URL from which identification request was sent.
+           * @description Page URL from which the identification request was sent.
            * @example https://some.website/path?query=params
@@ -532,3 +537,5 @@ */
           /** @description A customer-provided value or an object that was sent with identification request. */
-          tag?: { [key: string]: unknown };
+          tag: {
+            [key: string]: unknown;
+          };
           /**
@@ -539,3 +546,3 @@ * @description A customer-provided id that was sent with identification request.
           linkedId?: string;
-          confidence: components['schemas']['Confidence'];
+          confidence?: components['schemas']['Confidence'];
           /** @description Attribute represents if a visitor had been identified before. */
@@ -568,10 +575,3 @@ visitorFound: boolean;
       incognito?: {
-        data?: {
-          /**
-           * @description `true` if we detected incognito mode used in the browser, `false` otherwise.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['IncognitoResult'];
         error?: components['schemas']['ProductError'];
@@ -581,10 +581,3 @@ };
       rootApps?: {
-        data?: {
-          /**
-           * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client is not Android.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['RootAppsResult'];
         error?: components['schemas']['ProductError'];
@@ -594,10 +587,3 @@ };
       emulator?: {
-        data?: {
-          /**
-           * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['EmulatorResult'];
         error?: components['schemas']['ProductError'];
@@ -607,10 +593,3 @@ };
       clonedApp?: {
-        data?: {
-          /**
-           * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['ClonedAppResult'];
         error?: components['schemas']['ProductError'];
@@ -620,18 +599,3 @@ };
       factoryReset?: {
-        data?: {
-          /**
-           * Time
-           * Format: date-time
-           * @description Time in UTC for the Android client when recent factory reset was done.  If there is no sign of factory reset or the client isn't Android, the field will be epoch time.
-           *
-           * @example 2022-06-09T22:58:36Z
-           */
-          time?: string;
-          /**
-           * Format: int64
-           * @description Same value as it's in the `time` field but represented in timestamp format.
-           * @example 1654815517198
-           */
-          timestamp?: number;
-        };
+        data?: components['schemas']['FactoryResetResult'];
         error?: components['schemas']['ProductError'];
@@ -641,10 +605,3 @@ };
       jailbroken?: {
-        data?: {
-          /**
-           * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['JailbrokenResult'];
         error?: components['schemas']['ProductError'];
@@ -654,10 +611,3 @@ };
       frida?: {
-        data?: {
-          /**
-           * @description iOS specific [Frida](https://frida.re/docs/ios/) detection. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not iOS.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['FridaResult'];
         error?: components['schemas']['ProductError'];
@@ -672,10 +622,3 @@ };
       tor?: {
-        data?: {
-          /**
-           * @description `true` if the request IP address is a known tor exit node, `false` otherwise.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['TorResult'];
         error?: components['schemas']['ProductError'];
@@ -685,10 +628,3 @@ };
       privacySettings?: {
-        data?: {
-          /**
-           * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['PrivacySettingsResult'];
         error?: components['schemas']['ProductError'];
@@ -698,10 +634,3 @@ };
       virtualMachine?: {
-        data?: {
-          /**
-           * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['VirtualMachineResult'];
         error?: components['schemas']['ProductError'];
@@ -716,10 +645,3 @@ };
       proxy?: {
-        data?: {
-          /**
-           * @description `true` if the request IP address is used by a public proxy provider, `false` otherwise.
-           *
-           * @example false
-           */
-          result?: boolean;
-        };
+        data?: components['schemas']['ProxyResult'];
         error?: components['schemas']['ProductError'];
@@ -742,5 +664,11 @@ };
       };
+      /** SignalResponseSuspectScore */
+      suspectScore?: {
+        data?: components['schemas']['SuspectScoreResult'];
+        error?: components['schemas']['ProductError'];
+      };
       /** SignalResponseRawDeviceAttributes */
       rawDeviceAttributes?: {
         data?: components['schemas']['RawDeviceAttributesResult'];
+        error?: components['schemas']['ProductError'];
       };
@@ -750,3 +678,4 @@ };
     EventResponse: {
-      products?: components['schemas']['ProductsResponse'];
+      products: components['schemas']['ProductsResponse'];
+      error?: components['schemas']['ProductError'];
     };
@@ -782,3 +711,2 @@ IdentificationError: {
       /**
-       * Format: uri-reference
        * @description Page URL from which identification request was sent.
@@ -789,5 +717,7 @@ * @example https://example.com/login
       /** @example Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36 */
-      userAgent?: string;
+      userAgent: string;
       /** @example 1681392853693.lRiBBD */
-      requestId?: string;
+      requestId: string;
+      /** @example Automatic tests bot */
+      linkedId?: string;
       bot: components['schemas']['BotdDetectionResult'];
@@ -817,4 +747,4 @@ };
          */
-        address?: string;
-        geolocation?: components['schemas']['IPLocation'];
+        address: string;
+        geolocation: components['schemas']['IPLocation'];
         asn?: components['schemas']['ASN'];
@@ -828,4 +758,4 @@ datacenter?: components['schemas']['DataCenter'];
          */
-        address?: string;
-        geolocation?: components['schemas']['IPLocation'];
+        address: string;
+        geolocation: components['schemas']['IPLocation'];
         asn?: components['schemas']['ASN'];
@@ -841,4 +771,4 @@ datacenter?: components['schemas']['DataCenter'];
        */
-      result?: boolean;
-      details?: {
+      result: boolean;
+      details: {
         /**
@@ -848,3 +778,3 @@ * @description IP address was part of a known email spam attack (SMTP).
          */
-        emailSpam?: boolean;
+        emailSpam: boolean;
         /**
@@ -854,3 +784,3 @@ * @description IP address was part of a known network attack (SSH/HTTPS).
          */
-        attackSource?: boolean;
+        attackSource: boolean;
       };
@@ -863,3 +793,3 @@ };
        */
-      result?: boolean;
+      result: boolean;
       /**
@@ -869,4 +799,9 @@ * @description Local timezone which is used in timezoneMismatch method.
        */
-      originTimezone?: string;
-      methods?: {
+      originTimezone: string;
+      /**
+       * @description Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown).
+       * @example unknown
+       */
+      originCountry?: string;
+      methods: {
         /**
@@ -876,3 +811,3 @@ * @description User's browser timezone doesn't match the timezone from which the request was originally made.
          */
-        timezoneMismatch?: boolean;
+        timezoneMismatch: boolean;
         /**
@@ -882,3 +817,3 @@ * @description Request IP address is owned and used by a public VPN service provider.
          */
-        publicVPN?: boolean;
+        publicVPN: boolean;
         /**
@@ -888,3 +823,3 @@ * @description This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices.
          */
-        auxiliaryMobile?: boolean;
+        auxiliaryMobile: boolean;
       };
@@ -897,3 +832,3 @@ };
        */
-      result?: boolean;
+      result: boolean;
       /**
@@ -903,3 +838,3 @@ * @description Confidence score (`0.0 - 1.0`) for the tampering detection. Values above `0.5` suggest that we're reasonably sure there was a tampering attempt. Values below `0.5` are genuine browsers.
        */
-      anomalyScore?: number;
+      anomalyScore: number;
     };
@@ -911,3 +846,3 @@ HighActivityResult: {
        */
-      result?: boolean;
+      result: boolean;
       /**
@@ -921,7 +856,15 @@ * @description Number of requests from the same visitor in the previous day.
       /**
-       * @description Flag indicating whether the request came from a device with location spoofing enabled.
+       * @description Flag indicating whether the request came from a mobile device with location spoofing enabled.
        * @example false
        */
-      result?: boolean;
+      result: boolean;
     };
+    SuspectScoreResult: {
+      /**
+       * @description Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow.  It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity. The value range is [0; S] where S is sum of all Smart Signals weights.  See more details here: https://dev.fingerprint.com/docs/suspect-score
+       *
+       * @example 0
+       */
+      result: number;
+    };
     /**
@@ -944,2 +887,98 @@ * @description It includes 35+ raw browser identification attributes to provide Fingerprint users with even more information than our standard visitor ID provides. This enables Fingerprint users to not have to run our open-source product in conjunction with Fingerprint Pro Plus and Enterprise to get those additional attributes.
     };
+    FactoryResetResult: {
+      /**
+       * Time
+       * Format: date-time
+       * @description Time in UTC when the most recent factory reset of the Android or iOS device was done.  If there is no sign of factory reset or the client is not a mobile device, the field will contain the epoch time (1 January 1970) in UTC.
+       *
+       * @example 2022-06-09T22:58:36Z
+       */
+      time: string;
+      /**
+       * Format: int64
+       * @description Same value as it's in the `time` field but represented in timestamp format.
+       * @example 1654815517198
+       */
+      timestamp: number;
+    };
+    ClonedAppResult: {
+      /**
+       * @description Android specific cloned application detection. There are 2 values: • `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). • `false` - No signs of cloned application detected or the client is not Android.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    EmulatorResult: {
+      /**
+       * @description Android specific emulator detection. There are 2 values: • `true` - Emulated environment detected (e.g. launch inside of AVD) • `false` - No signs of emulated environment detected or the client is not Android.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    RootAppsResult: {
+      /**
+       * @description Android specific root management apps detection. There are 2 values: • `true` - Root Management Apps detected (e.g. Magisk) • `false` - No Root Management Apps detected or the client isn't Android.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    IncognitoResult: {
+      /**
+       * @description `true` if we detected incognito mode used in the browser, `false` otherwise.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    JailbrokenResult: {
+      /**
+       * @description iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak detected • `false` - No signs of jailbreak or the client is not iOS.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    FridaResult: {
+      /**
+       * @description [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values: • `true` - Frida detected • `false` - No signs of Frida or the client is not a mobile device.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    TorResult: {
+      /**
+       * @description `true` if the request IP address is a known tor exit node, `false` otherwise.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    PrivacySettingsResult: {
+      /**
+       * @description `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    VirtualMachineResult: {
+      /**
+       * @description `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
+    ProxyResult: {
+      /**
+       * @description `true` if the request IP address is used by a public proxy provider, `false` otherwise.
+       *
+       * @example false
+       */
+      result: boolean;
+    };
     ProductError: {
@@ -959,8 +998,18 @@ /**
   };
+  responses: never;
+  parameters: never;
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
 }
 
+export type $defs = Record<string, never>;
+
+export type external = Record<string, never>;
+
 export interface operations {
   /**
-   * This endpoint allows you to get a detailed analysis of an individual request.
-   * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request orignated from a non-mobile platform.
+   * Get event by requestId
+   * @description This endpoint allows you to get a detailed analysis of an individual request.
+   * **Only for Enterprise customers:** Please note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform.
    * It is highly recommended that you **ignore** the mobile signals for such requests.
@@ -973,3 +1022,3 @@ *
       path: {
-        /** The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request. */
+        /** @description The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each analysis request. */
         request_id: string;
@@ -979,3 +1028,3 @@ };
     responses: {
-      /** OK */
+      /** @description OK */
       200: {
@@ -986,3 +1035,3 @@ content: {
       };
-      /** Forbidden */
+      /** @description Forbidden */
       403: {
@@ -993,3 +1042,3 @@ content: {
       };
-      /** Not found */
+      /** @description Not found */
       404: {
@@ -1003,3 +1052,4 @@ content: {
   /**
-   * This endpoint allows you to get a history of visits for a specific `visitorId`. Use the `visitorId` as a URL path parameter.
+   * Get visits by visitorId
+   * @description This endpoint allows you to get a history of visits for a specific `visitorId`. Use the `visitorId` as a URL path parameter.
    * Only information from the _Identification_ product is returned.
@@ -1013,9 +1063,5 @@ *
     parameters: {
-      path: {
-        /** Unique identifier of the visitor issued by Fingerprint Pro. */
-        visitor_id: string;
-      };
-      query: {
+      query?: {
         /**
-         * Filter visits by `requestId`.
+         * @description Filter visits by `requestId`.
          *
@@ -1026,3 +1072,3 @@ * Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/docs/js-agent#requestid). When you filter visits by `requestId`, only one visit will be returned.
         /**
-         * Filter visits by your custom identifier.
+         * @description Filter visits by your custom identifier.
          *
@@ -1033,3 +1079,3 @@ * You can use [`linkedId`](https://dev.fingerprint.com/docs/js-agent#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier.
         /**
-         * Limit scanned results.
+         * @description Limit scanned results.
          *
@@ -1041,3 +1087,3 @@ * For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first).
         /**
-         * Use `paginationKey` to get the next page of results.
+         * @description Use `paginationKey` to get the next page of results.
          *
@@ -1052,8 +1098,15 @@ * When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results:
         paginationKey?: string;
-        /** ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. */
+        /** @description ⚠️ Deprecated pagination method, please use `paginationKey` instead. Timestamp (in milliseconds since epoch) used to paginate results. */
         before?: number;
       };
+      path: {
+        /**
+         * @description Unique identifier of the visitor issued by Fingerprint Pro.
+         * @example uYIm7Ksp5rf00SllPhFp
+         */
+        visitor_id: string;
+      };
     };
     responses: {
-      /** OK */
+      /** @description OK */
       200: {
@@ -1064,3 +1117,3 @@ content: {
       };
-      /** Forbidden. The API Key is probably missing or incorrect. */
+      /** @description Forbidden. The API Key is probably missing or incorrect. */
       403: {
@@ -1071,6 +1124,6 @@ content: {
       };
-      /** Too Many Requests */
+      /** @description Too Many Requests */
       429: {
         headers: {
-          /** Indicates how long you should wait before attempting the next request. */
+          /** @description Indicates how long you should wait before attempting the next request. */
           'Retry-After'?: number;
@@ -1085,3 +1138,1 @@ };
 }
-
-export interface external {}

No alert changes

Improved metrics

Total package byte prevSize

183967

increased by3.15%

Lines of code

4250

increased by3.53%

No dependency changes