Skip to content

fingerprintjs/fingerprintjs

Repository files navigation

FingerprintJS logo

Build status Current NPM version Monthly downloads from NPM Monthly downloads from jsDelivr

Discord server

FingerprintJS is a source-available, client-side, browser fingerprinting library that queries browser attributes and computes a hashed visitor identifier from them. Unlike cookies and local storage, a fingerprint stays the same in incognito/private mode and even when browser data is purged.

License

Starting version 4.0.0, FingerprintJS is licensed under Business Source License 1.1. The BSL allows use only for non-production purposes. You can learn more details in our announcement.

Use Case Is a commercial license required?
Exploring FingerprintJS for your own research, hobbies, and testing purposes No
Using FingerprintJS to build a proof-of-concept application No
Using FingerprintJS to build revenue-generating applications Yes
Using FingerprintJS to build software that is provided as a service (SaaS) Yes
Forking FingerprintJS for any production purposes Yes

To purchase a license for uses not authorized by BSL, please contact us at sales@fingerprint.com.

Demo

Visit https://fingerprintjs.github.io/fingerprintjs to know your visitor identifier.

Now, try visiting the same page in private / incognito mode and notice how the visitor identifier remains the same!

Getting Started

<script>
  // Initialize the agent at application startup.
  // If you're using an ad blocker or Brave/Firefox, this import will not work.
  // Please use the NPM package instead: https://t.ly/ORyXk
  const fpPromise = import('https://openfpcdn.io/fingerprintjs/v4')
    .then(FingerprintJS => FingerprintJS.load())

  // Get the visitor identifier when you need it.
  fpPromise
    .then(fp => fp.get())
    .then(result => {
      // This is the visitor identifier:
      const visitorId = result.visitorId
      console.log(visitorId)
    })
</script>

Run this code

Resources

📕 API Reference

⚛️ Sample usage with React on the StackBlitz platform

Limitations

Accuracy

Since FingerprintJS processes and generates the fingerprints from within the browser itself, the accuracy is limited (40% - 60%). For example, when 2 different users send requests using identical (i.e. same version, same vendor, same platform), browsers, FingerprintJS will not be able to tell these two browsers apart, primarily because the attribitutes from these browsers will be identical.

Security

Because of how the fingerprints are processed and generated from within the browser itself, they are vulnerable to spoofing and reverse engineering.

Get 99.5% accuracy

Fingerprint Identification is a closed-source, commercial device identification product designed for fraud detection, device identification, marketing attribution, and analytics. This product is an enhanced version of FingerprintJS and has been fully re-designed to solve the most challenging identification use cases. Its source is not available in this or any other public repository.

Fingerprint Identification is able to achieve 99.5% accuracy, because it processes the browser attributes on the server and also analyzes vast amounts of auxiliary data (e.g. IP addresses, time of visit patterns, URL changes, etc.). Because of these advanced matching techniques, Fingerprint Identification is able to reliably deduplicate different users that have identical devices. For a comprehensive list of advantages over FingerprintJS, please visit Fingerprint Identification vs. FingerprintJS.

Fingerprint Identification is available for Web, Android, iOS, and other platforms. Our plans start at $99 per month and include with them 20K API calls. You can easily get started by signing up for a free, no-obligation 14-day trial.

Resources

🍿 Fingerprint Identification live demo

▶️ Video: Use Fingerprint Identification to prevent multiple signups by same user

🗂️ Sample responses for the different Fingerprint Identification plans

⏱️ How to upgrade from FingerprintJS to Fingerprint Identification in 30 seconds

📕 Fingerprint Identification documentation

Migrating to v4

Migrating from Migration Guide Documentation
v3 Migrating from v3 to v4 v3 documentation
v2 Migrating from v2 to v4 v2 documentation
v1 Migrating from v1 to v4 v1 documentation

Version policy

See the compatibility policy for the API and visitor identifiers in the version policy guide.

Supported browsers

The library supports all popular browsers. See more details and learn how to run the library in old browsers in the browser support guide.

Where to get support

Using Issues and Discussions publicly will help the open-source community and other users with similar issues. However, if you require private support, please email us at oss-support@fingerprint.com.

Contributing

See the contribution guidelines to learn how to start a playground, test, and build.