Sync OpenAPI Schema (16709)

[fingerprint-dx-team-actions-runner]

This PR automatically updates the OpenAPI schema.

Changes

6 file(s) modified, 1 file(s) added

Modified files

• schemas/components/schemas/Event.yaml
• schemas/components/schemas/smartsignals/TamperingConfidence.yaml
• schemas/paths/examples/events/get_event_200.json
• schemas/paths/examples/events/get_event_ruleset_200.json
• schemas/paths/examples/events/get_event_with_bot_info_200.json
• schemas/paths/examples/events/search/get_event_search_200.json

Added files

• schemas/components/schemas/smartsignals/ProxyMLScore.yaml

---

Note for reviewers: Please review the schema changes.
You likely need to manually add a changeset file to this branch before merging.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 6705883

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[fingerprint-dx-team-actions-runner]

✅The changes have been finalized. This PR is ready for review.

[github-actions]

Schema Diff vs Published Schemas

• Generated at: 2026-03-31T11:28:03.620Z
• Published source: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas
• Compared schemas: 7
• Changed schemas: 3

fingerprint-server-api-v4-normalized.yaml

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-normalized.yaml
Summary: +2 added, -1 removed, ~0 modified

Added elements (2)

• /components/schemas/Event/properties/proxy_ml_score
• /components/schemas/ProxyMLScore

Removed elements (1)

• /components/schemas/TamperingConfidence/enum

Modified elements (0)

None

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -1348,10 +1348,20 @@
           description: >
             String representing the last proxy service provider detected when
             this
 
             IP was synced. An IP can be shared by multiple service providers.
+    ProxyMLScore:
+      type: number
+      format: double
+      minimum: 0
+      maximum: 1
+      description: >
+        Machine learning–based proxy score, represented as a floating-point
+        value between 0 and 1 (inclusive), with up to three decimal places of
+        precision. A higher score means a higher confidence in the positive
+        `proxy` detection result
     Incognito:
       type: boolean
       description: >
         `true` if we detected incognito mode used in the browser, `false`
         otherwise.
@@ -1496,14 +1506,10 @@
         either:
           * There are inconsistencies in the browser configuration that cross internal tampering thresholds (see `tampering_details.anomaly_score`).
           * The browser signature resembles an "anti-detect" browser specifically designed to evade fingerprinting (see `tampering_details.anti_detect_browser`).
     TamperingConfidence:
       type: string
-      enum:
-        - low
-        - medium
-        - high
       description: |
         Confidence level of the tampering detection.
         If a proxy is not detected, confidence is "high".
         If it's detected, can be "low", "medium", or "high".
     TamperingMlScore:
@@ -2191,10 +2197,14 @@
           $ref: '#/components/schemas/ProxyDetails'
           x-platforms:
             - android
             - ios
             - browser
+        proxy_ml_score:
+          $ref: '#/components/schemas/ProxyMLScore'
+          x-platforms:
+            - browser
         incognito:
           $ref: '#/components/schemas/Incognito'
           x-platforms:
             - browser
         jailbroken:

fingerprint-server-api-v4-with-examples.yaml

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-with-examples.yaml
Summary: +6 added, -1 removed, ~0 modified

Added elements (6)

• /components/schemas/Event/properties/proxy_ml_score
• /components/schemas/ProxyMLScore
• /paths/~1events/get/responses/200/content/application~1json/examples/200-ok/value/events/0/proxy_ml_score
• /paths/~1events~1{event_id}/get/responses/200/content/application~1json/examples/200-ok-with-bot-info/value/proxy_ml_score
• /paths/~1events~1{event_id}/get/responses/200/content/application~1json/examples/200-ok-with-ruleset/value/proxy_ml_score
• /paths/~1events~1{event_id}/get/responses/200/content/application~1json/examples/200-ok/value/proxy_ml_score

Removed elements (1)

• /components/schemas/TamperingConfidence/enum

Modified elements (0)

None

Changed lines patch

--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -168,10 +168,11 @@
                     proxy_confidence: low
                     proxy_details:
                       proxy_type: residential
                       last_seen_at: 1708102555327
                       provider: Massive
+                    proxy_ml_score: 0.2
                     vpn: false
                     vpn_confidence: high
                     vpn_origin_timezone: Europe/Berlin
                     vpn_origin_country: unknown
                     vpn_methods:
@@ -407,10 +408,11 @@
                     proxy_confidence: low
                     proxy_details:
                       proxy_type: residential
                       last_seen_at: 1708102555327
                       provider: Massive
+                    proxy_ml_score: 0.2
                     vpn: false
                     vpn_confidence: high
                     vpn_origin_timezone: Europe/Berlin
                     vpn_origin_country: unknown
                     vpn_methods:
@@ -661,10 +663,11 @@
                     proxy: true
                     proxy_confidence: low
                     proxy_details:
                       proxy_type: residential
                       last_seen_at: 1708102555327
+                    proxy_ml_score: 0.2
                     vpn: false
                     vpn_confidence: high
                     vpn_origin_timezone: Europe/Berlin
                     vpn_origin_country: unknown
                     vpn_methods:
@@ -1628,10 +1631,11 @@
                         proxy_confidence: low
                         proxy_details:
                           proxy_type: residential
                           last_seen_at: 1708102555327
                           provider: Massive
+                        proxy_ml_score: 0.2
                         vpn: false
                         vpn_confidence: high
                         vpn_origin_timezone: Europe/Berlin
                         vpn_origin_country: unknown
                         vpn_methods:
@@ -2629,10 +2633,20 @@
           description: >
             String representing the last proxy service provider detected when
             this
 
             IP was synced. An IP can be shared by multiple service providers.
+    ProxyMLScore:
+      type: number
+      format: double
+      minimum: 0
+      maximum: 1
+      description: >
+        Machine learning–based proxy score, represented as a floating-point
+        value between 0 and 1 (inclusive), with up to three decimal places of
+        precision. A higher score means a higher confidence in the positive
+        `proxy` detection result
     Incognito:
       type: boolean
       description: >
         `true` if we detected incognito mode used in the browser, `false`
         otherwise.
@@ -2815,14 +2829,10 @@
         either:
           * There are inconsistencies in the browser configuration that cross internal tampering thresholds (see `tampering_details.anomaly_score`).
           * The browser signature resembles an "anti-detect" browser specifically designed to evade fingerprinting (see `tampering_details.anti_detect_browser`).
     TamperingConfidence:
       type: string
-      enum:
-        - low
-        - medium
-        - high
       description: |
         Confidence level of the tampering detection.
         If a proxy is not detected, confidence is "high".
         If it's detected, can be "low", "medium", or "high".
     TamperingMlScore:
@@ -3524,10 +3534,14 @@
           $ref: '#/components/schemas/ProxyDetails'
           x-platforms:
             - android
             - ios
             - browser
+        proxy_ml_score:
+          $ref: '#/components/schemas/ProxyMLScore'
+          x-platforms:
+            - browser
         incognito:
           $ref: '#/components/schemas/Incognito'
           x-platforms:
             - browser
         jailbroken:

fingerprint-server-api-v4.yaml

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4.yaml
Summary: +2 added, -1 removed, ~0 modified

Added elements (2)

• /components/schemas/Event/properties/proxy_ml_score
• /components/schemas/ProxyMLScore

Removed elements (1)

• /components/schemas/TamperingConfidence/enum

Modified elements (0)

None

Changed lines patch

--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -1348,10 +1348,20 @@
           description: >
             String representing the last proxy service provider detected when
             this
 
             IP was synced. An IP can be shared by multiple service providers.
+    ProxyMLScore:
+      type: number
+      format: double
+      minimum: 0
+      maximum: 1
+      description: >
+        Machine learning–based proxy score, represented as a floating-point
+        value between 0 and 1 (inclusive), with up to three decimal places of
+        precision. A higher score means a higher confidence in the positive
+        `proxy` detection result
     Incognito:
       type: boolean
       description: >
         `true` if we detected incognito mode used in the browser, `false`
         otherwise.
@@ -1532,14 +1542,10 @@
         either:
           * There are inconsistencies in the browser configuration that cross internal tampering thresholds (see `tampering_details.anomaly_score`).
           * The browser signature resembles an "anti-detect" browser specifically designed to evade fingerprinting (see `tampering_details.anti_detect_browser`).
     TamperingConfidence:
       type: string
-      enum:
-        - low
-        - medium
-        - high
       description: |
         Confidence level of the tampering detection.
         If a proxy is not detected, confidence is "high".
         If it's detected, can be "low", "medium", or "high".
     TamperingMlScore:
@@ -2227,10 +2233,14 @@
           $ref: '#/components/schemas/ProxyDetails'
           x-platforms:
             - android
             - ios
             - browser
+        proxy_ml_score:
+          $ref: '#/components/schemas/ProxyMLScore'
+          x-platforms:
+            - browser
         incognito:
           $ref: '#/components/schemas/Incognito'
           x-platforms:
             - browser
         jailbroken:

[github-actions]

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm run changeset

to create a changeset.

[ilfa]

Didn't synced yet