Skip to main content
GET
/
events
Search events
curl --request GET \
  --url https://api.fpjs.io/v4/events \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "linked_id": "somelinkedId",
      "tags": {},
      "timestamp": 1708102555327,
      "event_id": "1708102555327.NLOjmg",
      "url": "https://www.example.com/login?hope{this{works[!",
      "ip_address": "61.127.217.15",
      "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....",
      "client_referrer": "https://example.com/blog/my-article",
      "browser_details": {
        "browser_name": "Chrome",
        "browser_major_version": "74",
        "browser_full_version": "74.0.3729",
        "os": "Windows",
        "os_version": "7",
        "device": "Other"
      },
      "identification": {
        "visitor_id": "Ibk1527CUFmcnjLwIs4A9",
        "confidence": {
          "score": 0.97,
          "version": "1.1"
        },
        "visitor_found": false,
        "first_seen_at": 1708102555327,
        "last_seen_at": 1708102555327
      },
      "supplementary_id_high_recall": {
        "visitor_id": "3HNey93AkBW6CRbxV6xP",
        "visitor_found": true,
        "confidence": {
          "score": 0.97,
          "version": "1.1"
        },
        "first_seen_at": 1708102555327,
        "last_seen_at": 1708102555327
      },
      "proximity": {
        "id": "w1aTfd4MCvl",
        "precision_radius": 10,
        "confidence": 0.95
      },
      "bot": "not_detected",
      "root_apps": false,
      "emulator": false,
      "ip_info": {
        "v4": {
          "address": "94.142.239.124",
          "geolocation": {
            "accuracy_radius": 20,
            "latitude": 50.05,
            "longitude": 14.4,
            "postal_code": "150 00",
            "timezone": "Europe/Prague",
            "city_name": "Prague",
            "country_code": "CZ",
            "country_name": "Czechia",
            "continent_code": "EU",
            "continent_name": "Europe",
            "subdivisions": [
              {
                "iso_code": "10",
                "name": "Hlavni mesto Praha"
              }
            ]
          },
          "asn": "7922",
          "asn_name": "COMCAST-7922",
          "asn_network": "73.136.0.0/13",
          "asn_type": "isp",
          "datacenter_result": true,
          "datacenter_name": "DediPath"
        },
        "v6": {
          "address": "2001:db8:3333:4444:5555:6666:7777:8888",
          "geolocation": {
            "accuracy_radius": 5,
            "latitude": 49.982,
            "longitude": 36.2566,
            "postal_code": "10112",
            "timezone": "Europe/Berlin",
            "city_name": "Berlin",
            "country_code": "DE",
            "country_name": "Germany",
            "continent_code": "EU",
            "continent_name": "Europe",
            "subdivisions": [
              {
                "iso_code": "BE",
                "name": "Land Berlin"
              }
            ]
          },
          "asn": "6805",
          "asn_name": "Telefonica Germany",
          "asn_network": "2a02:3100::/24",
          "asn_type": "isp",
          "datacenter_result": false,
          "datacenter_name": ""
        }
      },
      "ip_blocklist": {
        "email_spam": false,
        "attack_source": false,
        "tor_node": false
      },
      "proxy": true,
      "proxy_confidence": "low",
      "proxy_details": {
        "proxy_type": "residential",
        "last_seen_at": 1708102555327
      },
      "vpn": false,
      "vpn_confidence": "high",
      "vpn_origin_timezone": "Europe/Berlin",
      "vpn_origin_country": "unknown",
      "vpn_methods": {
        "timezone_mismatch": false,
        "public_vpn": false,
        "auxiliary_mobile": false,
        "os_mismatch": false,
        "relay": false
      },
      "incognito": false,
      "tampering": false,
      "tampering_details": {
        "anomaly_score": 0.1955,
        "anti_detect_browser": false
      },
      "cloned_app": false,
      "factory_reset_timestamp": 0,
      "jailbroken": false,
      "frida": false,
      "privacy_settings": false,
      "virtual_machine": false,
      "location_spoofing": false,
      "velocity": {
        "distinct_ip": {
          "5_minutes": 1,
          "1_hour": 1,
          "24_hours": 1
        },
        "distinct_country": {
          "5_minutes": 1,
          "1_hour": 2,
          "24_hours": 2
        },
        "events": {
          "5_minutes": 1,
          "1_hour": 5,
          "24_hours": 5
        },
        "ip_events": {
          "5_minutes": 1,
          "1_hour": 5,
          "24_hours": 5
        },
        "distinct_ip_by_linked_id": {
          "5_minutes": 1,
          "1_hour": 5,
          "24_hours": 5
        },
        "distinct_visitor_id_by_linked_id": {
          "5_minutes": 1,
          "1_hour": 5,
          "24_hours": 5
        }
      },
      "developer_tools": false,
      "mitm_attack": false,
      "sdk": {
        "platform": "js",
        "version": "3.11.10",
        "integrations": [
          {
            "name": "fingerprint-pro-react",
            "version": "3.11.10",
            "subintegration": {
              "name": "preact",
              "version": "10.21.0"
            }
          }
        ]
      },
      "replayed": false,
      "high_activity_device": false
    }
  ],
  "pagination_key": "1708102555327"
}

Authorizations

​
Authorization
string
header
required

Add your Secret API Key to the Authorization header using the standard Bearer format: Authorization: Bearer <secret_api_key>

Query Parameters

​
limit
integer<int32>
default:10

Limit the number of events returned.

Required range: 1 <= x <= 100
Example:

10

​
pagination_key
string

Use pagination_key to get the next page of results.

When more results are available (e.g., you requested up to 100 results for your query using limit, but there are more than 100 events total matching your request), the pagination_key field is added to the response. The key corresponds to the timestamp of the last returned event. In the following request, use that value in the pagination_key parameter to get the next page of results:

  1. First request, returning most recent 200 events: GET api-base-url/events?limit=100
  2. Use response.pagination_key to get the next page of results: GET api-base-url/events?limit=100&pagination_key=1740815825085
​
visitor_id
string

Unique visitor identifier issued by Fingerprint Identification and all active Smart Signals. Filter for events matching this visitor_id.

​
bot
enum<string>

Filter events by the Bot Detection result, specifically: all - events where any kind of bot was detected. good - events where a good bot was detected. bad - events where a bad bot was detected. none - events where no bot was detected.

Note: When using this parameter, only events with the botd.bot property set to a valid value are returned. Events without a botd Smart Signal result are left out of the response.

Available options:
all,
good,
bad,
none
​
ip_address
string

Filter events by IP address or IP range (if CIDR notation is used). If CIDR notation is not used, a /32 for IPv4 or /128 for IPv6 is assumed. Examples of range based queries: 10.0.0.0/24, 192.168.0.1/32

​
asn
string

Filter events by the ASN associated with the event's IP address. This corresponds to the ip_info.(v4|v6).asn property in the response.

​
linked_id
string

Filter events by your custom identifier.

You can use linked Ids to associate identification requests with your own identifier, for example, session Id, purchase Id, or transaction Id. You can then use this linked_id parameter to retrieve all events associated with your custom identifier.

​
url
string

Filter events by the URL (url property) associated with the event.

​
origin
string

Filter events by the origin field of the event. Origin could be the website domain or mobile app bundle ID (eg: com.foo.bar)

​
start
integer<int64>

Filter events with a timestamp greater than the start time, in Unix time (milliseconds).

​
end
integer<int64>

Filter events with a timestamp smaller than the end time, in Unix time (milliseconds).

​
reverse
boolean

Sort events in reverse timestamp order.

​
suspect
boolean

Filter events previously tagged as suspicious via the Update API.

Note: When using this parameter, only events with the suspect property explicitly set to true or false are returned. Events with undefined suspect property are left out of the response.

​
vpn
boolean

Filter events by VPN Detection result.

Note: When using this parameter, only events with the vpn property set to true or false are returned. Events without a vpn Smart Signal result are left out of the response.

​
virtual_machine
boolean

Filter events by Virtual Machine Detection result.

Note: When using this parameter, only events with the virtual_machine property set to true or false are returned. Events without a virtual_machine Smart Signal result are left out of the response.

​
tampering
boolean

Filter events by Browser Tampering Detection result.

Note: When using this parameter, only events with the tampering.result property set to true or false are returned. Events without a tampering Smart Signal result are left out of the response.

​
anti_detect_browser
boolean

Filter events by Anti-detect Browser Detection result.

Note: When using this parameter, only events with the tampering.anti_detect_browser property set to true or false are returned. Events without a tampering Smart Signal result are left out of the response.

​
incognito
boolean

Filter events by Browser Incognito Detection result.

Note: When using this parameter, only events with the incognito property set to true or false are returned. Events without an incognito Smart Signal result are left out of the response.

​
privacy_settings
boolean

Filter events by Privacy Settings Detection result.

Note: When using this parameter, only events with the privacy_settings property set to true or false are returned. Events without a privacy_settings Smart Signal result are left out of the response.

​
jailbroken
boolean

Filter events by Jailbroken Device Detection result.

Note: When using this parameter, only events with the jailbroken property set to true or false are returned. Events without a jailbroken Smart Signal result are left out of the response.

​
frida
boolean

Filter events by Frida Detection result.

Note: When using this parameter, only events with the frida property set to true or false are returned. Events without a frida Smart Signal result are left out of the response.

​
factory_reset
boolean

Filter events by Factory Reset Detection result.

Note: When using this parameter, only events with a factory_reset time. Events without a factory_reset Smart Signal result are left out of the response.

​
cloned_app
boolean

Filter events by Cloned App Detection result.

Note: When using this parameter, only events with the cloned_app property set to true or false are returned. Events without a cloned_app Smart Signal result are left out of the response.

​
emulator
boolean

Filter events by Android Emulator Detection result.

Note: When using this parameter, only events with the emulator property set to true or false are returned. Events without an emulator Smart Signal result are left out of the response.

​
root_apps
boolean

Filter events by Rooted Device Detection result.

Note: When using this parameter, only events with the root_apps property set to true or false are returned. Events without a root_apps Smart Signal result are left out of the response.

​
vpn_confidence
enum<string>

Filter events by VPN Detection result confidence level. high - events with high VPN Detection confidence. medium - events with medium VPN Detection confidence. low - events with low VPN Detection confidence.

Note: When using this parameter, only events with the vpn.confidence property set to a valid value are returned. Events without a vpn Smart Signal result are left out of the response.

Available options:
high,,
medium,
low
​
min_suspect_score
number<float>

Filter events with Suspect Score result above a provided minimum threshold.

Note: When using this parameter, only events where the suspect_score property set to a value exceeding your threshold are returned. Events without a suspect_score Smart Signal result are left out of the response.

​
developer_tools
boolean

Filter events by Developer Tools detection result.

Note: When using this parameter, only events with the developer_tools property set to true or false are returned. Events without a developer_tools Smart Signal result are left out of the response.

​
location_spoofing
boolean

Filter events by Location Spoofing detection result.

Note: When using this parameter, only events with the location_spoofing property set to true or false are returned. Events without a location_spoofing Smart Signal result are left out of the response.

​
mitm_attack
boolean

Filter events by MITM (Man-in-the-Middle) Attack detection result.

Note: When using this parameter, only events with the mitm_attack property set to true or false are returned. Events without a mitm_attack Smart Signal result are left out of the response.

​
proxy
boolean

Filter events by Proxy detection result.

Note: When using this parameter, only events with the proxy property set to true or false are returned. Events without a proxy Smart Signal result are left out of the response.

​
sdk_version
string

Filter events by a specific SDK version associated with the identification event (sdk.version property). Example: 3.11.14

​
sdk_platform
enum<string>

Filter events by the SDK Platform associated with the identification event (sdk.platform property) . js - Javascript agent (Web). ios - Apple iOS based devices. android - Android based devices.

Available options:
js,
android,
ios
​
environment
string[]

Filter for events by providing one or more environment IDs (environment_id property).

​
proximity_id
string

Filter events by the most precise Proximity ID provided by default.

Note: When using this parameter, only events with the proximity.id property matching the provided ID are returned. Events without a proximity result are left out of the response.

​
total_hits
integer<int64>

When set, the response will include a total_hits property with a count of total query matches across all pages, up to the specified limit.

Required range: 1 <= x <= 1000

Response

Events matching the filter(s).

Contains a list of all identification events matching the specified search criteria.

​
events
object[]
required
​
pagination_key
string

Use this value in the pagination_key parameter to request the next page of search results.

​
total_hits
integer<int64>

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.