> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fingerprint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start Guide

> How to quickly add Fingerprint device intelligence to your website or mobile app.

[Fingerprint](https://fingerprint.com/) is a device intelligence platform that helps businesses protect their applications from fraud, account takeover, spam, bots, and other malicious activity. Fingerprint capabilities include:

* [**Visitor identification**](https://fingerprint.com/products/identification/): Recognize returning browsers and mobile devices with industry-leading accuracy, without relying on cookies or IP addresses. Every visitor gets a visitor ID like `e0srMXYG7PjFCAbE0yIH` that cannot be deleted, lasts much longer than a cookie, and stays the same even if the visitor uses incognito mode or a VPN.
* [**Smart Signals**](https://fingerprint.com/products/smart-signals/): Detect suspicious device configurations like bots, VPN users, tampered browsers, or jailbroken phones with our actionable device intelligence insights.

In this guide, we will quickly get you started identifying your visitors using Fingerprint so you can test it out yourself. If you would like a practical demo of Fingerprint capabilities first, see our [Playground](https://demo.fingerprint.com/playground) or explore [Use cases](https://demo.fingerprint.com/). If you want a deeper understanding of our platform, see [Introduction](/docs/introduction).

## 1. Create an account

1. [Sign up for your free trial](https://dashboard.fingerprint.com/signup?utm_source=/docs/v3/quick-start-guide) to get started, no credit card is required.
2. You can choose to store all your Fingerprint data in the United States, Germany, or India. See [Regions](/docs/v3/regions) for more information.

<Accordion title="Having trouble accessing the Dashboard?">
  Please make sure you have the following domains allowed in your Firewall: -
  [https://fingerprint.com](https://fingerprint.com) - https\://\*.fingerprint.com - [https://api.fpjs.pro](https://api.fpjs.pro)
</Accordion>

## 2. Get your API Key

1. In the Dashboard, navigate to [**API Keys**](https://dashboard.fingerprint.com/api-keys) in the left-hand menu.
2. Under **Public Keys**, copy or save your public API key to run the examples below.

If you've just created your account, please allow a minute or two for your API key to propagate before using it.

<img src="https://mintcdn.com/fingerprint/iRu-EffBrNwcQzg3/images/0fbf312623d4ba84af09917ff87cdc2cca3ead7fcdd6210697128d76563b93f0-CleanShot_2024-11-06_at_11.00.582x.png?fit=max&auto=format&n=iRu-EffBrNwcQzg3&q=85&s=20a1f52330e9d91ad18e1c1272a34fe4" alt="" width="3138" height="1658" data-path="images/0fbf312623d4ba84af09917ff87cdc2cca3ead7fcdd6210697128d76563b93f0-CleanShot_2024-11-06_at_11.00.582x.png" />

## 3. Add the client-side agent

Once you've created your account and got your public API key, you can [add the JavaScript agent](/docs/v3/install-the-javascript-agent) to your website or add a native SDK to your [iOS](/docs/ios) or [Android app](/docs/native-android-integration). The agent collects browser or device attributes, sends them to the Fingerprint backend, and receives a **visitor ID** for that browser or mobile device.

The easiest way to add the agent is by going to the [**SDKs & integrations**](https://dashboard.fingerprint.com/integrations) page and picking your preferred web or mobile library.

<img src="https://mintcdn.com/fingerprint/iRu-EffBrNwcQzg3/images/9a76d28875166b2b3826b80fcecc4e0f5257f8b4fc1469d2cfee3ddc08766356-CleanShot_2024-11-06_at_11.04.032x.png?fit=max&auto=format&n=iRu-EffBrNwcQzg3&q=85&s=53df94fff356cb09a68a8339e1593d3a" alt="" width="3140" height="2208" data-path="images/9a76d28875166b2b3826b80fcecc4e0f5257f8b4fc1469d2cfee3ddc08766356-CleanShot_2024-11-06_at_11.04.032x.png" />

For example, you can install the JavaScript agent loader as an NPM package:

<CodeGroup>
  `shell NPM npm install @fingerprintjs/fingerprintjs-pro ` `shell yarn yarn add
      @fingerprintjs/fingerprintjs-pro ` `shell PNPM pnpm add @fingerprintjs/fingerprintjs-pro `
</CodeGroup>

Or you can add the JavaScript agent directly into your HTML using our CDN.

<CodeGroup>
  ```ts HTML theme={"theme":"github-dark-dimmed"}
  <script>
    // Initialize the agent at application startup.
    // Some ad blockers or browsers will block Fingerprint CDN URL.
    // To fix this, use a custom subdomain or a proxy integration.
    // (see info box below)
    const fpPromise = import('https://fpjscdn.net/v3/PUBLIC_API_KEY')
      .then(FingerprintJS => FingerprintJS.load({ region: "us" }));

    // Get the visitor identifier when you need it.
    fpPromise
    .then(fp => fp.get())
    .then(result => console.log(result.visitorId, result.requestId));

  </script>
  ```

  ```javascript NPM theme={"theme":"github-dark-dimmed"}
  import FingerprintJS from '@fingerprintjs/fingerprintjs-pro'

  // Initialize an agent at application startup.
  const fpPromise = FingerprintJS.load({
    apiKey: 'PUBLIC_API_KEY',
    region: 'us',
  })

  // Get the visitor identifier when you need it.
  fpPromise
    .then(fp => fp.get())
    .then(result => console.log(result.visitorId, result.requestId))
  ```
</CodeGroup>

> Note: Each workspace exists in a specific region. If you have chosen Europe or Asia as your [data region](/docs/v3/regions), you must specify the [`region`](/reference/v3/js-agent-load-function#region) option as `eu` or `ap` in your agent configuration to match your workspace.

Every identification request will return a unique visitorId value for the current visitor. For more information, see the [JavaScript agent API Reference](/reference/v3/javascript-agent), [Android](/docs/native-android-integration), or [iOS](/docs/ios) guide.

<Note>
  **Working with ad blockers and privacy-focused browsers**

  Requests from client agents to Fingerprint APIs are often blocked by ad-blockers or privacy-focused browsers like Brave. Make sure to disable your ad blocker when trying out the examples above.

  You can protect the client agent from ad blockers by proxying requests through your own domain. We offer a variety of ready-made proxy integrations to choose from. See [Custom subdomain setup](/docs/v3/custom-subdomain-setup) to get the minimum recommended ad blocker protection.

  To identify 100% of visitors with maximum possible accuracy, use one of our cloud proxy integrations. See [Protecting the JavaScript agent from ad blockers](/docs/v3/protecting-the-javascript-agent-from-adblockers) for more details.
</Note>

## 4. Get Smart Signals to your server

[Smart Signals](/docs/v3/smart-signals-introduction) are actionable device intelligence insights about your visitors. These include *IP Geolocation*, *Bot detection*, *Incognito mode detection*, *VPN detection*, *Browser tampering detection*, and many more.

For security reasons, Smart Signals are unavailable in the [response](/reference/v3/js-agent-get-function#get-response) returned to the client agent. You can securely access them in a server-side environment using [Server API](/reference/v3/server-api), [Webhooks](/docs/v3/webhooks), or [Sealed Client Results](/docs/v3/sealed-client-results).

For example, to use the **Server API**:

1. Identify a visitor on your client. The response will include a [`requestId`](/reference/v3/js-agent-get-function#requestid).
2. Send the request ID to your server.
3. Use the Server API [`/events/REQUEST_ID`](/reference/v3/server-api-get-event) endpoint to retrieve all information for that identification event, including Smart Signals.

<CodeGroup>
  ```curl cURL  theme={"theme":"github-dark-dimmed"}
  curl --request GET \
       --url https://api.fpjs.io/events/REQUEST_ID \
       --header 'Auth-API-Key: SECRET_API_KEY' \
       --header 'accept: application/json'
  ```

  ```json Response theme={"theme":"github-dark-dimmed"}
  {
    "products": {
      "identification": {
        "data": {
          "visitorId": "Ibk1527CUFmcnjLwIs4A9",
          "requestId": "1708102555327.NLOjmg",
          "incognito": true,
          "linkedId": "somelinkedId",
          "tag": {},
          "time": "2019-05-21T16:40:13Z",
          "timestamp": 1582299576512,
          "url": "https://www.example.com/login?hope{this{works[!",
          "ip": "61.127.217.15",
          "ipLocation": {
            "accuracyRadius": 10,
            "latitude": 49.982,
            "longitude": 36.2566,
            "postalCode": "61202",
            "timezone": "Europe/Dusseldorf",
            "city": {
              "name": "Dusseldorf"
            },
            "country": {
              "code": "DE",
              "name": "Germany"
            },
            "continent": {
              "code": "EU",
              "name": "Europe"
            },
            "subdivisions": [
              {
                "isoCode": "63",
                "name": "North Rhine-Westphalia"
              }
            ]
          },
          "browserDetails": {
            "browserName": "Chrome",
            "browserMajorVersion": "74",
            "browserFullVersion": "74.0.3729",
            "os": "Windows",
            "osVersion": "7",
            "device": "Other",
            "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) ...."
          },
          "confidence": {
            "score": 0.97
          },
          "visitorFound": false,
          "firstSeenAt": {
            "global": "2022-03-16T11:26:45.362Z",
            "subscription": "2022-03-16T11:31:01.101Z"
          },
          "lastSeenAt": {
            "global": null,
            "subscription": null
          }
        }
      },
      "botd": {
        "data": {
          "bot": {
            "result": "notDetected"
          },
          "url": "https://www.example.com/login?hope{this{works}[!",
          "ip": "61.127.217.15",
          "time": "2019-05-21T16:40:13Z",
          "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 YaBrowser/24.1.0.0 Safari/537.36",
          "requestId": "1708102555327.NLOjmg"
        }
      },
      "rootApps": {
        "data": {
          "result": false
        }
      },
      "emulator": {
        "data": {
          "result": false
        }
      },
      "ipInfo": {
        "data": {
          "v4": {
            "address": "94.142.239.124",
            "geolocation": {
              "accuracyRadius": 20,
              "latitude": 50.05,
              "longitude": 14.4,
              "postalCode": "150 00",
              "timezone": "Europe/Prague",
              "city": {
                "name": "Prague"
              },
              "country": {
                "code": "CZ",
                "name": "Czechia"
              },
              "continent": {
                "code": "EU",
                "name": "Europe"
              },
              "subdivisions": [
                {
                  "isoCode": "10",
                  "name": "Hlavni mesto Praha"
                }
              ]
            },
            "asn": {
              "asn": "7922",
              "name": "COMCAST-7922",
              "network": "73.136.0.0/13"
            },
            "datacenter": {
              "result": true,
              "name": "DediPath"
            }
          },
          "v6": {
            "address": "2001:db8:3333:4444:5555:6666:7777:8888",
            "geolocation": {
              "accuracyRadius": 5,
              "latitude": 49.982,
              "longitude": 36.2566,
              "postalCode": "10112",
              "timezone": "Europe/Berlin",
              "city": {
                "name": "Berlin"
              },
              "country": {
                "code": "DE",
                "name": "Germany"
              },
              "continent": {
                "code": "EU",
                "name": "Europe"
              },
              "subdivisions": [
                {
                  "isoCode": "BE",
                  "name": "Land Berlin"
                }
              ]
            },
            "asn": {
              "asn": "6805",
              "name": "Telefonica Germany",
              "network": "2a02:3100::/24"
            },
            "datacenter": {
              "result": false,
              "name": ""
            }
          }
        }
      },
      "ipBlocklist": {
        "data": {
          "result": false,
          "details": {
            "emailSpam": false,
            "attackSource": false
          }
        }
      },
      "tor": {
        "data": {
          "result": false
        }
      },
      "vpn": {
        "data": {
          "result": false,
          "originTimezone": "Europe/Berlin",
          "originCountry": "unknown",
          "methods": {
            "timezoneMismatch": false,
            "publicVPN": false,
            "auxiliaryMobile": false,
            "osMismatch": false
          }
        }
      },
      "proxy": {
        "data": {
          "result": false
        }
      },
      "incognito": {
        "data": {
          "result": false
        }
      },
      "tampering": {
        "data": {
          "result": false,
          "anomalyScore": 0.1955
        }
      },
      "clonedApp": {
        "data": {
          "result": false
        }
      },
      "factoryReset": {
        "data": {
          "time": "1970-01-01T00:00:00Z",
          "timestamp": 0
        }
      },
      "jailbroken": {
        "data": {
          "result": false
        }
      },
      "frida": {
        "data": {
          "result": false
        }
      },
      "privacySettings": {
        "data": {
          "result": false
        }
      },
      "virtualMachine": {
        "data": {
          "result": false
        }
      },
      "rawDeviceAttributes": {
        "data": {
          "architecture": {
            "value": 127
          },
          "audio": {
            "value": 35.73832903057337
          },
          "canvas": {
            "value": {
              "Winding": true,
              "Geometry": "4dce9d6017c3e0c052a77252f29f2b1c",
              "Text": "dd2474a56ff78c1de3e7a07070ba3b7d"
            }
          },
          "colorDepth": {
            "value": 30
          },
          "colorGamut": {
            "value": "p3"
          },
          "contrast": {
            "value": 0
          },
          "cookiesEnabled": {
            "value": true
          },
          "cpuClass": {},
          "fonts": {
            "value": [
              "Arial Unicode MS",
              "Gill Sans",
              "Helvetica Neue",
              "Menlo"
            ]
          }
        }
      },
      "highActivity": {
        "data": {
          "result": false
        }
      },
      "locationSpoofing": {
        "data": {
          "result": false
        }
      },
      "remoteControl": {
        "data": {
          "result": false
        }
      },
      "velocity": {
        "data": {
          "distinctIp": {
            "intervals": {
              "5m": 1,
              "1h": 1,
              "24h": 1
            }
          },
          "distinctLinkedId": {},
          "distinctCountry": {
            "intervals": {
              "5m": 1,
              "1h": 2,
              "24h": 2
            }
          },
          "events": {
            "intervals": {
              "5m": 1,
              "1h": 5,
              "24h": 5
            }
          }
        }
      },
      "developerTools": {
        "data": {
          "result": false
        }
      }
    }
  }
  ```
</CodeGroup>

> Note: If you have chosen Europe or Asia as your [data region](/docs/v3/regions), use `eu.api.fpjs.io` or `ap.api.fpjs.io` respectively.

You must authenticate your requests to the Server API using your *Secret API Key*. You can create one on the [**API Keys**](https://dashboard.fingerprint.com/api-keys) page (same as the Public API key). Please allow a minute or two for your API key to propagate before using it.

<img src="https://mintcdn.com/fingerprint/fvYn10A20JCNEe87/images/f148d49f1b2636394a001e0bd6216857142415f89611af10f5d774f4233ddc67-CleanShot_2024-11-06_at_11.05.302x.png?fit=max&auto=format&n=fvYn10A20JCNEe87&q=85&s=9432d85b4806dac37b9c6ccaf9607b2a" alt="" width="3132" height="2082" data-path="images/f148d49f1b2636394a001e0bd6216857142415f89611af10f5d774f4233ddc67-CleanShot_2024-11-06_at_11.05.302x.png" />

We support several [server-side SDKs](/reference/server-sdks) to make it easier to work with the Fingerprint Server API and other resources. You can go to the [**Integrations**](https://dashboard.fingerprint.com/integrations) page and pick your preferred server language.

## Try Fingerprint in your browser

Use this developer sandbox [project](https://stackblitz.com/edit/fpjs-pro-3-cdn?devtoolsheight=1000\&embed=1\&file=index.html\&hideExplorer=1\&hideNavigation=1\&theme=light) to try Fingerprint in your browser.

## What's next

* Not sure Fingerprint is for you? See our [Playground](https://demo.fingerprint.com/playground), [Use cases](https://demo.fingerprint.com/), or [Case studies](https://fingerprint.com/case-studies/).
* Questions about how exactly it all works? See the *Understanding Fingerprint* section, starting with [Introduction](/docs/introduction).
* Thinking through your approach? See [Planning your implementation](/docs/planning-implementation) for common best practices.
* Ready to start? See the detailed guide for installing the [JavaScript](/docs/v3/install-the-javascript-agent), [iOS](/docs/ios), or [Android](/docs/native-android-integration) agents.
* Get in touch with our [Sales team](https://fingerprint.com/contact-sales/), [Support team](https://fingerprint.com/support/), or join our [Discord server](https://discord.com/invite/ad6R2ttHVX).