Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/BotInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**category** | **str** | The type and purpose of the bot. |
**provider** | **str** | The organization or company operating the bot. |
**provider_url** | **str** | The URL of the bot provider's website. | [optional]
**provider_url** | **str** | The URL of the bot provider's website. | [optional]
**name** | **str** | The specific name or identifier of the bot. |
**identity** | **str** | The verification status of the bot's identity: * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider. * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider’s customers. * `spoofed` - bot that claims a public identity but fails verification. * `unknown` - bot that does not publish a verifiable identity. |
**identity** | **str** | The verification status of the bot's identity: * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider. * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider’s customers. * `spoofed` - bot that claims a public identity but fails verification. * `unknown` - bot that does not publish a verifiable identity. |
**confidence** | **str** | Confidence level of the bot identification. |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/Canvas.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Canvas fingerprint containing winding flag plus geometry/text hashes.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**winding** | **bool** | | [optional]
**geometry** | **str** | Hash of geometry rendering output or `unsupported` markers. | [optional]
**text** | **str** | Hash of text rendering output or `unsupported` markers. | [optional]
**geometry** | **str** | Hash of geometry rendering output or `unsupported` markers. | [optional]
**text** | **str** | Hash of text rendering output or `unsupported` markers. | [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)

42 changes: 21 additions & 21 deletions docs/Event.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,53 @@ Contains results from Fingerprint Identification and all active Smart Signals.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event_id** | **str** | Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp For example: `1758130560902.8tRtrH` |
**event_id** | **str** | Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp For example: `1758130560902.8tRtrH` |
**timestamp** | **int** | Timestamp of the event with millisecond precision in Unix time. |
**linked_id** | **str** | A customer-provided id that was sent with the request. | [optional]
**environment_id** | **str** | Environment Id of the event. For example: `ae_47abaca3db2c7c43` | [optional]
**suspect** | **bool** | Field is `true` if you have previously set the `suspect` flag for this event using the [Server API Update event endpoint](https://docs.fingerprint.com/reference/server-api-v4-update-event). | [optional]
**environment_id** | **str** | Environment Id of the event. For example: `ae_47abaca3db2c7c43` | [optional]
**suspect** | **bool** | Field is `true` if you have previously set the `suspect` flag for this event using the [Server API Update event endpoint](https://docs.fingerprint.com/reference/server-api-v4-update-event). | [optional]
**sdk** | [**SDK**](SDK.md) | | [optional]
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional]
**replayed** | **bool** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional]
**identification** | [**Identification**](Identification.md) | | [optional]
**supplementary_id_high_recall** | [**SupplementaryIDHighRecall**](SupplementaryIDHighRecall.md) | | [optional]
**tags** | **Dict[str, object]** | A customer-provided value or an object that was sent with the identification request or updated later. | [optional]
**url** | **str** | Page URL from which the request was sent. For example `https://example.com/` | [optional]
**bundle_id** | **str** | Bundle Id of the iOS application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` | [optional]
**package_name** | **str** | Package name of the Android application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` | [optional]
**url** | **str** | Page URL from which the request was sent. For example `https://example.com/` | [optional]
**bundle_id** | **str** | Bundle Id of the iOS application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` | [optional]
**package_name** | **str** | Package name of the Android application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` | [optional]
**ip_address** | **str** | IP address of the requesting browser or bot. | [optional]
**user_agent** | **str** | User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....` | [optional]
**client_referrer** | **str** | Client Referrer field corresponds to the `document.referrer` field gathered during an identification request. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, by using a bookmark) For example: `https://example.com/blog/my-article` | [optional]
**user_agent** | **str** | User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....` | [optional]
**client_referrer** | **str** | Client Referrer field corresponds to the `document.referrer` field gathered during an identification request. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, by using a bookmark) For example: `https://example.com/blog/my-article` | [optional]
**browser_details** | [**BrowserDetails**](BrowserDetails.md) | | [optional]
**proximity** | [**Proximity**](Proximity.md) | | [optional]
**bot** | [**BotResult**](BotResult.md) | | [optional]
**bot_type** | **str** | Additional classification of the bot type if detected. | [optional]
**bot_info** | [**BotInfo**](BotInfo.md) | | [optional]
**cloned_app** | **bool** | 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. | [optional]
**developer_tools** | **bool** | `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise. | [optional]
**emulator** | **bool** | 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. | [optional]
**cloned_app** | **bool** | 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. | [optional]
**developer_tools** | **bool** | `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise. | [optional]
**emulator** | **bool** | 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. | [optional]
**factory_reset_timestamp** | **int** | The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time. When a factory reset cannot be detected on the mobile device or when the request is initiated from a browser, this field will correspond to the *epoch* time (i.e 1 Jan 1970 UTC) as a value of 0. See [Factory Reset Detection](https://docs.fingerprint.com/docs/smart-signals-reference#factory-reset-detection) to learn more about this Smart Signal. | [optional]
**frida** | **bool** | [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. | [optional]
**frida** | **bool** | [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. | [optional]
**ip_blocklist** | [**IPBlockList**](IPBlockList.md) | | [optional]
**ip_info** | [**IPInfo**](IPInfo.md) | | [optional]
**proxy** | **bool** | IP address was used by a public proxy provider or belonged to a known recent residential proxy | [optional]
**proxy_confidence** | [**ProxyConfidence**](ProxyConfidence.md) | | [optional]
**proxy_details** | [**ProxyDetails**](ProxyDetails.md) | | [optional]
**incognito** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional]
**jailbroken** | **bool** | iOS specific jailbreak detection. There are 2 values: * `true` - Jailbreak detected. * `false` - No signs of jailbreak or the client is not iOS. | [optional]
**incognito** | **bool** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional]
**jailbroken** | **bool** | iOS specific jailbreak detection. There are 2 values: * `true` - Jailbreak detected. * `false` - No signs of jailbreak or the client is not iOS. | [optional]
**location_spoofing** | **bool** | Flag indicating whether the request came from a mobile device with location spoofing enabled. | [optional]
**mitm_attack** | **bool** | * `true` - When requests made from your users' mobile devices to Fingerprint servers have been intercepted and potentially modified. * `false` - Otherwise or when the request originated from a browser. See [MitM Attack Detection](https://docs.fingerprint.com/docs/smart-signals-reference#mitm-attack-detection) to learn more about this Smart Signal. | [optional]
**privacy_settings** | **bool** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. | [optional]
**root_apps** | **bool** | 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. | [optional]
**mitm_attack** | **bool** | * `true` - When requests made from your users' mobile devices to Fingerprint servers have been intercepted and potentially modified. * `false` - Otherwise or when the request originated from a browser. See [MitM Attack Detection](https://docs.fingerprint.com/docs/smart-signals-reference#mitm-attack-detection) to learn more about this Smart Signal. | [optional]
**privacy_settings** | **bool** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. | [optional]
**root_apps** | **bool** | 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. | [optional]
**rule_action** | [**EventRuleAction**](EventRuleAction.md) | | [optional]
**suspect_score** | **int** | 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://docs.fingerprint.com/docs/suspect-score | [optional]
**tampering** | **bool** | Flag indicating browser tampering was detected. This happens when 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`). | [optional]
**tampering** | **bool** | Flag indicating browser tampering was detected. This happens when 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`). | [optional]
**tampering_details** | [**TamperingDetails**](TamperingDetails.md) | | [optional]
**velocity** | [**Velocity**](Velocity.md) | | [optional]
**virtual_machine** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. | [optional]
**virtual_machine** | **bool** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. | [optional]
**vpn** | **bool** | VPN or other anonymizing service has been used when sending the request. | [optional]
**vpn_confidence** | [**VpnConfidence**](VpnConfidence.md) | | [optional]
**vpn_origin_timezone** | **str** | Local timezone which is used in timezone_mismatch method. | [optional]
**vpn_origin_country** | **str** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional]
**vpn_origin_country** | **str** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional]
**vpn_methods** | [**VpnMethods**](VpnMethods.md) | | [optional]
**high_activity_device** | **bool** | Flag indicating if the request came from a high-activity visitor. | [optional]
**raw_device_attributes** | [**RawDeviceAttributes**](RawDeviceAttributes.md) | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/EventSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Contains a list of all identification events matching the specified search crite
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**events** | [**List[Event]**](Event.md) | |
**pagination_key** | **str** | Use this value in the `pagination_key` parameter to request the next page of search results. | [optional]
**total_hits** | **int** | This value represents the total number of events matching the search query, up to the limit provided in the `total_hits` query parameter. Only present if the `total_hits` query parameter was provided. | [optional]
**pagination_key** | **str** | Use this value in the `pagination_key` parameter to request the next page of search results. | [optional]
**total_hits** | **int** | This value represents the total number of events matching the search query, up to the limit provided in the `total_hits` query parameter. Only present if the `total_hits` query parameter was provided. | [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)

Loading
Loading