Skip to content

Latest commit

 

History

History
69 lines (65 loc) · 11.5 KB

File metadata and controls

69 lines (65 loc) · 11.5 KB

Event Class

Contains results from Fingerprint Identification and all active Smart Signals.

Properties

Name Type Description Notes
event_id string 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.
incremental_identification_status \Fingerprint\ServerSdk\Model\IncrementalIdentificationStatus [optional]
linked_id string A customer-provided id that was sent with the request. [optional]
environment_id string 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. [optional]
sdk \Fingerprint\ServerSdk\Model\SDK [optional]
replayed bool `true` if we determined that this payload was replayed, `false` otherwise. [optional]
identification \Fingerprint\ServerSdk\Model\Identification [optional]
supplementary_id_high_recall \Fingerprint\ServerSdk\Model\SupplementaryIDHighRecall [optional]
tags array<string,mixed> A customer-provided value or an object that was sent with the identification request or updated later. [optional]
url string Page URL from which the request was sent. For example `https://example.com/&#x60; [optional]
bundle_id string Bundle Id of the iOS application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` [optional]
package_name string Package name of the Android application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` [optional]
ip_address string IP address of the requesting browser or bot. [optional]
user_agent string User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....` [optional]
client_referrer string 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&#x60; [optional]
browser_details \Fingerprint\ServerSdk\Model\BrowserDetails [optional]
proximity \Fingerprint\ServerSdk\Model\Proximity [optional]
bot \Fingerprint\ServerSdk\Model\BotResult [optional]
bot_type string Additional classification of the bot type if detected. [optional]
bot_info \Fingerprint\ServerSdk\Model\BotInfo [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 has DevTools open (Chrome, Firefox) or the Android/iOS device has Developer Tools enabled, `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 to learn more about this Smart Signal. [optional]
frida bool Frida 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 \Fingerprint\ServerSdk\Model\IPBlockList [optional]
ip_info \Fingerprint\ServerSdk\Model\IPInfo [optional]
proxy bool IP address was used by a public proxy provider or belonged to a known recent residential proxy [optional]
proxy_confidence \Fingerprint\ServerSdk\Model\ProxyConfidence [optional]
proxy_details \Fingerprint\ServerSdk\Model\ProxyDetails [optional]
proxy_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. [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 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 \Fingerprint\ServerSdk\Model\EventRuleAction [optional]
simulator bool iOS specific simulator detection. There are 2 values: * `true` - Simulator environment detected. * `false` - No signs of simulator or the client is not iOS. [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 The field can be used as a standalone flag for tampering detection. Alternatively, the more granular fields documented below can be used for workflows that require more context. * `true` if tampering is detected through an anomalous browser signature, anti-detect browser detection, or other tampering-related methods * `false` if none of the tampering checks return a positive result [optional]
tampering_confidence \Fingerprint\ServerSdk\Model\TamperingConfidence [optional]
tampering_ml_score float The output of this model is captured as tampering_ml_score, a number indicating how likely an event is coming from an anti detect browser. Values close to 1 signify higher confidence and we consider anything above the threshold of 0.8 to be actionable (the result and anti_detect_browser fields conveniently captures that fact) [optional]
tampering_details \Fingerprint\ServerSdk\Model\TamperingDetails [optional]
velocity \Fingerprint\ServerSdk\Model\Velocity [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_ml_score float Machine learning–based virtual machine 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 `virtual_machine` detection result. This Smart Signal is currently in beta and only available to select customers. If you are interested, please contact our support team. [optional]
vpn bool VPN or other anonymizing service has been used when sending the request. [optional]
vpn_confidence \Fingerprint\ServerSdk\Model\VpnConfidence [optional]
vpn_origin_timezone string Local timezone which is used in timezone_mismatch method. [optional]
vpn_origin_country string Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). [optional]
vpn_methods \Fingerprint\ServerSdk\Model\VpnMethods [optional]
high_activity_device bool Flag indicating if the request came from a high-activity visitor. [optional]
rare_device 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`). > This Smart Signal is currently in beta and only available to select customers. If you are interested, please contact our support team. [optional]
rare_device_percentile_bucket \Fingerprint\ServerSdk\Model\RareDevicePercentileBucket [optional]
raw_device_attributes \Fingerprint\ServerSdk\Model\RawDeviceAttributes [optional]
labels \Fingerprint\ServerSdk\Model\LabelsInner[] 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. [optional]

[Back to Model list] [Back to API list] [Back to README]