Merge branch 'main' into chore/enable-automatic-readme-publish-again

fingerprintjs · Nov 21, 2024 · 9d0cc6a · 9d0cc6a
2 parents ec0dcae + adf30a1
commit 9d0cc6a
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 3 deletions.
diff --git a/.changeset/forty-seas-prove.md b/.changeset/forty-seas-prove.md
@@ -0,0 +1,5 @@
+---
+'fingerprint-pro-server-api-openapi': minor
+---
+
+Add `relay` detection method to the VPN Detection Smart Signal
diff --git a/schemas/components/schemas/VPNMethods.yaml b/schemas/components/schemas/VPNMethods.yaml
@@ -5,6 +5,7 @@ required:
   - publicVPN
   - auxiliaryMobile
   - osMismatch
+  - relay
 properties:
   timezoneMismatch:
     type: boolean
@@ -20,3 +21,12 @@ properties:
     type: boolean
     description: >-
       The browser runs on a different operating system than the operating system inferred from the request network signature.
+  relay:
+    type: boolean
+    description: |
+      Request IP address belongs to a relay service provider, indicating the use of relay services like [Apple Private relay](https://support.apple.com/en-us/102602) or [Cloudflare Warp](https://developers.cloudflare.com/warp-client/). 
+      
+      * Like VPNs, relay services anonymize the visitor's true IP address.
+      * Unlike traditional VPNs, relay services don't let visitors spoof their location by choosing an exit node in a different country.
+      
+      This field allows you to differentiate VPN users and relay service users in your fraud prevention logic.
diff --git a/schemas/paths/examples/get_event_200.json b/schemas/paths/examples/get_event_200.json
@@ -180,7 +180,8 @@
           "timezoneMismatch": false,
           "publicVPN": false,
           "auxiliaryMobile": false,
-          "osMismatch": false
+          "osMismatch": false,
+          "relay": false
         }
       }
     },

diff --git a/schemas/paths/examples/get_event_search_200.json b/schemas/paths/examples/get_event_search_200.json
@@ -182,7 +182,8 @@
             "timezoneMismatch": false,
             "publicVPN": false,
             "auxiliaryMobile": false,
-            "osMismatch": false
+            "osMismatch": false,
+            "relay": false
           }
         }
       },

diff --git a/schemas/paths/examples/webhook.json b/schemas/paths/examples/webhook.json
@@ -125,7 +125,8 @@
       "timezoneMismatch": false,
       "publicVPN": false,
       "auxiliaryMobile": false,
-      "osMismatch": false
+      "osMismatch": false,
+      "relay": false
     }
   },
   "proxy": {