fingerprintjs · erayaydin · Aug 3, 2026
@@ -337,6 +337,8 @@ Class | Method | HTTP request | Description
  - [Integration](docs/Integration.md)
  - [IntegrationSubintegration](docs/IntegrationSubintegration.md)
  - [Jailbroken](docs/Jailbroken.md)
+ - [Labels](docs/Labels.md)
+ - [LabelsInner](docs/LabelsInner.md)
  - [LocationSpoofing](docs/LocationSpoofing.md)
  - [MitMAttack](docs/MitMAttack.md)
  - [PrivacySettings](docs/PrivacySettings.md)
@@ -352,11 +354,13 @@ Class | Method | HTTP request | Description
  - [ProductIdentification](docs/ProductIdentification.md)
  - [ProductIncognito](docs/ProductIncognito.md)
  - [ProductJailbroken](docs/ProductJailbroken.md)
+ - [ProductLabels](docs/ProductLabels.md)
  - [ProductLocationSpoofing](docs/ProductLocationSpoofing.md)
  - [ProductMitMAttack](docs/ProductMitMAttack.md)
  - [ProductPrivacySettings](docs/ProductPrivacySettings.md)
  - [ProductProximity](docs/ProductProximity.md)
  - [ProductProxy](docs/ProductProxy.md)
+ - [ProductRareDevice](docs/ProductRareDevice.md)
  - [ProductRawDeviceAttributes](docs/ProductRawDeviceAttributes.md)
  - [ProductRemoteControl](docs/ProductRemoteControl.md)
  - [ProductRootApps](docs/ProductRootApps.md)
@@ -371,6 +375,7 @@ Class | Method | HTTP request | Description
  - [Proxy](docs/Proxy.md)
  - [ProxyConfidence](docs/ProxyConfidence.md)
  - [ProxyDetails](docs/ProxyDetails.md)
+ - [RareDevice](docs/RareDevice.md)
  - [RawDeviceAttribute](docs/RawDeviceAttribute.md)
  - [RawDeviceAttributeError](docs/RawDeviceAttributeError.md)
  - [RawDeviceAttributes](docs/RawDeviceAttributes.md)
@@ -410,6 +415,7 @@ Class | Method | HTTP request | Description
  - [WebhookPrivacySettings](docs/WebhookPrivacySettings.md)
  - [WebhookProximity](docs/WebhookProximity.md)
  - [WebhookProxy](docs/WebhookProxy.md)
+ - [WebhookRareDevice](docs/WebhookRareDevice.md)
  - [WebhookRawDeviceAttributes](docs/WebhookRawDeviceAttributes.md)
  - [WebhookRemoteControl](docs/WebhookRemoteControl.md)
  - [WebhookRootApps](docs/WebhookRootApps.md)

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**result** | **bool** | `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise.  | 
+**result** | **bool** | `true` if the browser has DevTools open (Chrome, Firefox) or the Android/iOS device has Developer Tools enabled, `false` otherwise.  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
@@ -278,7 +278,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **search_events**
-> SearchEventsResponse search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, proximity_precision_radius=proximity_precision_radius)
+> SearchEventsResponse search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, rare_device=rare_device, rare_device_percentile_bucket=rare_device_percentile_bucket, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, proximity_precision_radius=proximity_precision_radius)
 
 Get events via search
 
@@ -332,6 +332,8 @@ datacenter = True # bool | Filter events by Datacenter Detection result. > Note:
 developer_tools = True # bool | Filter events by Developer Tools detection result. > Note: When using this parameter, only events with the `products.developerTools.data.result` property set to `true` or `false` are returned. Events without a `products.developerTools` Smart Signal result are left out of the response.  (optional)
 location_spoofing = True # bool | Filter events by Location Spoofing detection result. > Note: When using this parameter, only events with the `products.locationSpoofing.data.result` property set to `true` or `false` are returned. Events without a `products.locationSpoofing` Smart Signal result are left out of the response.  (optional)
 mitm_attack = True # bool | Filter events by MITM (Man-in-the-Middle) Attack detection result. > Note: When using this parameter, only events with the `products.mitmAttack.data.result` property set to `true` or `false` are returned. Events without a `products.mitmAttack` Smart Signal result are left out of the response.  (optional)
+rare_device = True # bool | Filter events by Rare Device detection result. > Note: When using this parameter, only events with the `products.rareDevice.data.result` property set to `true` or `false` are returned. Events without a `products.rareDevice` Smart Signal result are left out of the response.  (optional)
+rare_device_percentile_bucket = 'rare_device_percentile_bucket_example' # str | Filter events by Rare Device percentile bucket. `<p95` - device configuration is in the bottom 95% (most common). `p95-p99` - device is in the 95th to 99th percentile. `p99-p99.5` - device is in the 99th to 99.5th percentile. `p99.5-p99.9` - device is in the 99.5th to 99.9th percentile. `p99.9+` - device is in the top 0.1% (rarest). `not_seen` - device configuration has never been observed before.  (optional)
 proxy = True # bool | Filter events by Proxy detection result. > Note: When using this parameter, only events with the `products.proxy.data.result` property set to `true` or `false` are returned. Events without a `products.proxy` Smart Signal result are left out of the response.  (optional)
 sdk_version = 'sdk_version_example' # str | Filter events by a specific SDK version associated with the identification event. Example: `3.11.14`  (optional)
 sdk_platform = 'sdk_platform_example' # str | Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices.  (optional)
@@ -341,7 +343,7 @@ proximity_precision_radius = 56 # int | Filter events by Proximity Radius. > Not
 
 try:
     # Get events via search
-    api_response = api_instance.search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, proximity_precision_radius=proximity_precision_radius)
+    api_response = api_instance.search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, ip_blocklist=ip_blocklist, datacenter=datacenter, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, rare_device=rare_device, rare_device_percentile_bucket=rare_device_percentile_bucket, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, proximity_precision_radius=proximity_precision_radius)
     print(api_response)
 except ApiException as e:
     print("Exception when calling FingerprintApi->search_events: %s\n" % e)
@@ -380,6 +382,8 @@ Name | Type | Description  | Notes
  **developer_tools** | **bool**| Filter events by Developer Tools detection result. > Note: When using this parameter, only events with the `products.developerTools.data.result` property set to `true` or `false` are returned. Events without a `products.developerTools` Smart Signal result are left out of the response.  | [optional] 
  **location_spoofing** | **bool**| Filter events by Location Spoofing detection result. > Note: When using this parameter, only events with the `products.locationSpoofing.data.result` property set to `true` or `false` are returned. Events without a `products.locationSpoofing` Smart Signal result are left out of the response.  | [optional] 
  **mitm_attack** | **bool**| Filter events by MITM (Man-in-the-Middle) Attack detection result. > Note: When using this parameter, only events with the `products.mitmAttack.data.result` property set to `true` or `false` are returned. Events without a `products.mitmAttack` Smart Signal result are left out of the response.  | [optional] 
+ **rare_device** | **bool**| Filter events by Rare Device detection result. > Note: When using this parameter, only events with the `products.rareDevice.data.result` property set to `true` or `false` are returned. Events without a `products.rareDevice` Smart Signal result are left out of the response.  | [optional] 
+ **rare_device_percentile_bucket** | **str**| Filter events by Rare Device percentile bucket. `<p95` - device configuration is in the bottom 95% (most common). `p95-p99` - device is in the 95th to 99th percentile. `p99-p99.5` - device is in the 99th to 99.5th percentile. `p99.5-p99.9` - device is in the 99.5th to 99.9th percentile. `p99.9+` - device is in the top 0.1% (rarest). `not_seen` - device configuration has never been observed before.  | [optional] 
  **proxy** | **bool**| Filter events by Proxy detection result. > Note: When using this parameter, only events with the `products.proxy.data.result` property set to `true` or `false` are returned. Events without a `products.proxy` Smart Signal result are left out of the response.  | [optional] 
  **sdk_version** | **str**| Filter events by a specific SDK version associated with the identification event. Example: `3.11.14`  | [optional] 
  **sdk_platform** | **str**| Filter events by the SDK Platform associated with the identification event. `js` - JavaScript agent (Web). `ios` - Apple iOS based devices. `android` - Android based devices.  | [optional] 

@@ -0,0 +1,11 @@
+# Labels
+Each label returns a prediction (true or false) for a specific use case (label field) based on a machine learning score. The machine learning score is determined by a model trained on customer data for that use case. This field is in the beta phase and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
@@ -0,0 +1,11 @@
+# LabelsInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **str** |  | [optional] 
+**prediction** | **bool** |  | [optional] 
+**ml_score** | **float** |  | [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)
+
@@ -0,0 +1,10 @@
+# ProductLabels
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Labels**](Labels.md) |  | [optional] 
+**error** | [**Error**](Error.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)
+
@@ -0,0 +1,10 @@
+# ProductRareDevice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**RareDevice**](RareDevice.md) |  | [optional] 
+**error** | [**Error**](Error.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)
+
@@ -30,7 +30,9 @@ Name | Type | Description | Notes
 **velocity** | [**ProductVelocity**](ProductVelocity.md) |  | [optional] 
 **developer_tools** | [**ProductDeveloperTools**](ProductDeveloperTools.md) |  | [optional] 
 **mitm_attack** | [**ProductMitMAttack**](ProductMitMAttack.md) |  | [optional] 
+**rare_device** | [**ProductRareDevice**](ProductRareDevice.md) |  | [optional] 
 **proximity** | [**ProductProximity**](ProductProximity.md) |  | [optional] 
+**labels** | [**ProductLabels**](ProductLabels.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)
 
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **result** | **bool** | IP address was used by a public proxy provider or belonged to a known recent residential proxy  | 
 **confidence** | [**ProxyConfidence**](ProxyConfidence.md) |  | 
 **details** | [**ProxyDetails**](ProxyDetails.md) |  | [optional] 
+**ml_score** | **float** | 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. This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).  | [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)
 
@@ -5,7 +5,7 @@ Proxy detection details (present if proxy is detected)
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**proxy_type** | **str** | Residential proxies use real user IP addresses to appear as legitimate traffic,  while data center proxies are public proxies hosted in data centers  | 
+**proxy_type** | **str** | Residential proxies use real user IP addresses to appear as legitimate traffic, while data center proxies are public proxies hosted in data centers. `unknown` is reported when a proxy is detected solely by the ML model and the IP sources did not determine a specific type.  | 
 **last_seen_at** | **datetime** | ISO 8601 formatted timestamp in UTC with hourly resolution of when this IP was last seen as a proxy when available.  | [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)

@@ -0,0 +1,14 @@
+# RareDevice
+Rare device details (present if the device is considered rare)
+> This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).
+
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **bool** | `true` if the device is considered rare based on its combination of hardware and software attributes. A device is classified as rare if it falls within the top 99.9 percentile (lowest-frequency segment) of observed traffic, or if its configuration has not been previously seen (`not_seen`).  | [optional] 
+**percentile_bucket** | **str** | The rarity percentile bucket of the device, indicating how uncommon the device configuration is compared to all observed devices.  | [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)
+
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **result** | **bool** | VPN or other anonymizing service has been used when sending the request. | 
 **confidence** | [**VPNConfidence**](VPNConfidence.md) |  | 
+**ml_score** | **float** | Machine learning–based VPN 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 `vpn` detection result. This Smart Signal is currently in beta and only available to select customers. If you are interested, please [contact our support team](https://fingerprint.com/support/).  | [optional] 
 **origin_timezone** | **str** | Local timezone which is used in timezoneMismatch method. | 
 **origin_country** | **str** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | 
 **methods** | [**VPNMethods**](VPNMethods.md) |  | 

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **auxiliary_mobile** | **bool** | This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices. | 
 **os_mismatch** | **bool** | The browser runs on a different operating system than the operating system inferred from the request network signature. | 
 **relay** | **bool** | 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.  | 
+**ml_prediction** | **bool** | `true` if the request came from a device running a VPN, `false` otherwise.    | [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)