Fingerprint

https://docs.fingerprint.com/docs
Admin
Fingerprint is a browser fingerprinting platform that identifies and tracks unique visitors to...
Tokens:185,054
Snippets:2,438
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install SQLite package

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Install the SQLite driver for Go.

```bash
go get modernc.org/sqlite
```

--------------------------------

### Install Dependencies

Source: https://docs.fingerprint.com/docs/python-server-quickstart

Command to install the specified project dependencies.

```bash
pip install -r requirements.txt
```

--------------------------------

### Start the development server

Source: https://docs.fingerprint.com/docs/account-sharing-use-case-tutorial

Launch the local server to begin testing the application.

```bash
npm run dev
```

--------------------------------

### Install Project Dependencies

Source: https://docs.fingerprint.com/docs/react-native-quickstart

Install the necessary node modules for the project.

```bash
npm install
```

--------------------------------

### Start Development Server

Source: https://docs.fingerprint.com/docs/angular-quickstart

Launches the local development server to preview the application.

```bash
npm start
```

--------------------------------

### Configure CORS and Start Server

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Set up CORS middleware and start the HTTP server on localhost:3000.

```go
originsOk := handlers.AllowedOrigins([]string{"*"})
methodsOk := handlers.AllowedMethods([]string{"GET", "HEAD", "POST", "PUT", "OPTIONS"})
headersOk := handlers.AllowedHeaders([]string{"Accept", "Accept-Language", "Content-Type", "Content-Language", "Origin"})

srv := &http.Server{
  Handler: handlers.CORS(originsOk, methodsOk, headersOk)(r),
  Addr:    "localhost:3000",
}

log.Printf("Server is running on http://localhost:3000")
log.Fatal(srv.ListenAndServe())
```

--------------------------------

### Run Go Server

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Execute the main Go file to start the server.

```bash
go run main.go
```

--------------------------------

### Start Fastify Server

Source: https://docs.fingerprint.com/docs/node-server-quickstart

Execute the server script to begin listening for requests.

```bash
node server.js
```

--------------------------------

### Install Fingerprint React SDK

Source: https://docs.fingerprint.com/docs/nextjs-quickstart

Install the required package via npm to begin integration.

```bash
npm install @fingerprint/react
```

--------------------------------

### Install Gorilla Handlers

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Install the required module to handle CORS configuration in your Go project.

```bash
go get github.com/gorilla/handlers
```

--------------------------------

### Install proxy integration dependencies

Source: https://docs.fingerprint.com/docs/akamai-v3-to-v4-migration-guide

Install required packages for the build process.

```bash
pnpm install
```

--------------------------------

### Install SQLite dependency

Source: https://docs.fingerprint.com/docs/node-server-quickstart

Install the sqlite3 package to enable database storage for account tracking.

```bash
npm install sqlite3
```

--------------------------------

### Install project dependencies

Source: https://docs.fingerprint.com/docs/account-sharing-use-case-tutorial

Run this command in the project root to install required Node.js packages.

```bash
npm install
```

--------------------------------

### Start React Native Development Server

Source: https://docs.fingerprint.com/docs/react-native-quickstart

Initializes the Metro bundler to serve the application.

```bash
npx react-native start
```

--------------------------------

### Run ASP.NET Server

Source: https://docs.fingerprint.com/docs/dotnet-server-quickstart

Execute this command in the terminal to start the ASP.NET server.

```bash
dotnet run
```

--------------------------------

### Run database setup script

Source: https://docs.fingerprint.com/docs/php-server-quickstart

Executes the PHP script to generate the database file.

```bash
php setup.php
```

--------------------------------

### Example Request Headers

Source: https://docs.fingerprint.com/docs/bot-detection/web-bot-auth-implementation

A sample collection of headers required for bot authentication requests.

```bash
Signature-Agent: "https://ai-agent.fyi"
Signature-Input: sig1=("@authority" "signature-agent")
 ;created=1735689600;expires=1735693200
 ;keyid="poqkLGiymh_W0uP6PZFw-dvez3QJT5SolqXBCW38r0U"
 ;alg="ed25519"
 ;nonce="3q2+7oBVKDJKNGHs1A9pYQ=="
 ;tag="web-bot-auth"
Signature: sig1=:jdq0SqOwHdyHr9+r5jw3iYZH6aNGKijYp/EstF4RQTQdi5N5YYKrD+mCT1HA1nZDsi6nJKuHxUi/5Syp3rLWBA==:
```

--------------------------------

### Start the FastAPI server

Source: https://docs.fingerprint.com/docs/python-server-quickstart

Execute this command in your terminal to launch the FastAPI application.

```bash
python server.py
```

--------------------------------

### Install SQLite package

Source: https://docs.fingerprint.com/docs/dotnet-server-quickstart

Add the Entity Framework Core SQLite package to the project.

```bash
dotnet add package Microsoft.EntityFrameworkCore.Sqlite
```

--------------------------------

### Initialize Go project and dependencies

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Create a new Go module and install the required gorilla/mux router and Fingerprint Go Server SDK.

```bash
mkdir fingerprint-go-quickstart && cd fingerprint-go-quickstart
go mod init fingerprint.com/go-quickstart
go get github.com/gorilla/mux github.com/fingerprintjs/go-sdk/v8
```

--------------------------------

### Set up basic gorilla/mux server

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Initialize a server on port 3000 with a POST route for handling account creation requests.

```go
package main

import (
  "encoding/json"
  "log"
  "net/http"

  "github.com/gorilla/mux"
)

func main() {
  r := mux.NewRouter()
  r.HandleFunc("/api/create-account", func(w http.ResponseWriter, r *http.Request) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusOK)
    json.NewEncoder(w).Encode(map[string]string{"status": "Account created!"})
  }).Methods("POST")

  http.Handle("/", r)
  srv := &http.Server{
    Handler: r,
    Addr:    "localhost:3000",
  }

  log.Printf("Server is running on http://localhost:3000")
  log.Fatal(srv.ListenAndServe())
}
```

--------------------------------

### Initialize Project and Install SDK

Source: https://docs.fingerprint.com/docs/dotnet-server-quickstart

Commands to create a new ASP.NET project and add the Fingerprint Server SDK dependency.

```bash
dotnet new web -o fingerprint-dotnet-quickstart -f net9.0
cd fingerprint-dotnet-quickstart
dotnet add package Fingerprint.ServerSdk
```

--------------------------------

### Install iOS Dependencies

Source: https://docs.fingerprint.com/docs/react-native-quickstart

Install native iOS dependencies using CocoaPods.

```bash
cd ios && pod install && cd ..
```

--------------------------------

### Install Fingerprint Vue SDK

Source: https://docs.fingerprint.com/docs/nuxt-quickstart

Install the required package via npm.

```bash
npm install @fingerprint/vue
```

--------------------------------

### Initialize Python Project

Source: https://docs.fingerprint.com/docs/python-server-quickstart

Commands to create a project directory and set up a virtual environment.

```bash
mkdir fingerprint-python-starter && cd fingerprint-python-starter
python -m venv venv
source venv/bin/activate  # On Windows: venv\\Scripts\\activate
```

--------------------------------

### Install Angular CLI

Source: https://docs.fingerprint.com/docs/angular-quickstart

Installs the Angular command-line interface globally on your system.

```bash
npm install -g @angular/cli
```

--------------------------------

### Initialize PHP Project

Source: https://docs.fingerprint.com/docs/php-server-quickstart

Create a project directory and install the required Fingerprint server SDK and dotenv packages.

```bash
mkdir fingerprint-php-quickstart && cd fingerprint-php-quickstart
composer init -n --name="demo/fp-php" --type=project
composer require fingerprint/server-sdk vlucas/phpdotenv
```

--------------------------------

### JSON Web Key Example

Source: https://docs.fingerprint.com/docs/bot-detection/web-bot-auth-implementation

Example of a public key in JWK format.

```json
{"kty":"OKP","crv":"Ed25519","x":"HzO8jiKnwNPaQZDnTzQN5_GrHwdFb8IqT-Z-HTxus44"}
```

--------------------------------

### Clone the starter repository

Source: https://docs.fingerprint.com/docs/account-takeover-use-case-tutorial

Use Git to clone the repository and navigate to the account-takeover directory.

```bash
git clone https://github.com/fingerprintjs/use-case-tutorials.git
cd use-case-tutorials/account-takeover
```

--------------------------------

### Initialize Node.js Project

Source: https://docs.fingerprint.com/docs/node-server-quickstart

Create a new directory and install the required Fastify and Fingerprint SDK dependencies.

```bash
mkdir fingerprint-node-quickstart && cd fingerprint-node-quickstart
npm init -y
npm install fastify @fingerprint/node-sdk
```

--------------------------------

### Clone the starter repository

Source: https://docs.fingerprint.com/docs/account-sharing-use-case-tutorial

Use this command to download the project files from the official repository.

```bash
git clone https://github.com/fingerprintjs/use-case-tutorials.git
```

--------------------------------

### Remove and install dependencies

Source: https://docs.fingerprint.com/docs/migrating-from-open-source-v2

Commands to remove legacy packages and install the new @fingerprint/agent package.

```bash
npm remove @fingerprintjs/fingerprintjs fingerprintjs2 @types/fingerprintjs__fingerprintjs @types/fingerprintjs2
npm install @fingerprint/agent
```

```bash
# Don't mind the "This module isn't specified in a package.json file" error
yarn remove @fingerprintjs/fingerprintjs fingerprintjs2 @types/fingerprintjs__fingerprintjs @types/fingerprintjs2
yarn add @fingerprint/agent
```

--------------------------------

### Initialize SQLite database

Source: https://docs.fingerprint.com/docs/go-server-quickstart

Open the database connection and create the accounts table.

```go
db, err := sql.Open("sqlite", "database.db")
if err != nil {
  log.Fatal(err)
  os.Exit(1)
}
db.Exec(`CREATE TABLE IF NOT EXISTS accounts (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  username TEXT,
  password TEXT,
  visitorId TEXT
)`)
defer db.Close()
```

--------------------------------

### Install Fingerprint JavaScript Agent

Source: https://docs.fingerprint.com/docs/javascript-quickstart

Use npm to install the required Fingerprint agent package.

```bash
npm install @fingerprint/agent
```

--------------------------------

### Initialize SQLite database

Source: https://docs.fingerprint.com/docs/dotnet-server-quickstart

Set up the database connection and create the accounts table.

```csharp
using Microsoft.Data.Sqlite;
var connectionString = "Data Source=database.db";
using var connection = new SqliteConnection(connectionString);
connection.Open();

var command = connection.CreateCommand();
command.CommandText = @"
    CREATE TABLE IF NOT EXISTS accounts (
        id INTEGER PRIMARY KEY AUTOINCREMENT,
        username TEXT,
        password TEXT,
        visitorId TEXT
    )";
command.ExecuteNonQuery();
```

--------------------------------

### Initialize React Native Project

Source: https://docs.fingerprint.com/docs/react-native-quickstart

Create a new project using the React Native CLI.

```bash
npx @react-native-community/cli init FingerprintQuickstart
cd FingerprintQuickstart
```

--------------------------------

### Verify Project Initialization

Source: https://docs.fingerprint.com/docs/angular-quickstart

Expected output after successful project creation.

```bash
✔ Packages installed successfully.
 Successfully initialized git.
```

--------------------------------

### Install Fastify CORS Plugin

Source: https://docs.fingerprint.com/docs/node-server-quickstart

Install the required dependency to handle cross-origin requests during local development.

```bash
npm install @fastify/cors
```

--------------------------------

### Install iOS dependencies

Source: https://docs.fingerprint.com/docs/fingerprintjs-pro-react-native

Run pod install within the ios directory to link native dependencies.

```shell
cd ios && pod install
```

--------------------------------

### Initialize a new Vite React project

Source: https://docs.fingerprint.com/docs/react-quickstart

Use these commands to scaffold a new project and install dependencies.

```bash
npm create vite@latest fingerprint-react-quickstart -- --template react
cd fingerprint-react-quickstart
npm install
```

--------------------------------

### Install Testing Browser

Source: https://docs.fingerprint.com/docs/account-takeover-use-case-tutorial

Ensures the required browser binaries are installed for automated testing tools like Puppeteer.

```bash
npx puppeteer browsers install chrome
```

--------------------------------

### Server API event response examples

Source: https://docs.fingerprint.com/docs/rules-engine

Examples of the rule_action object returned by the Server API for blocked and allowed requests.

```json
{
  "event_id": "1768992558661.2J0stP",
  "identification": { /* ... */ },
  "incognito": true,
  "rule_action": {
    "ruleset_id": "rs_OyQUaHCx9tgkFp",
    "rule_id": "r_SGSkm40YLdBSGo",
    "rule_expression": "incognito",
    "type": "block",
    "status_code": 403,
    "headers": [
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": "{\"message\": \"Incognito not allowed\"}"
  },
  /* ... */ 
}
```

```json
{
  "event_id": "1768992462622.Xk9nJu",
  "identification": { /* ... */ },
  "incognito": false,
  "rule_action": {
    "ruleset_id": "rs_OyQUaHCx9tgkFp",
    "type": "allow"
  },
  /* ... */
}
```

--------------------------------

### Define CSP directives for installation methods

Source: https://docs.fingerprint.com/docs/js-agent-csp

Required CSP directives for CDN and NPM installations to unblock the agent and WebWorker download.

```text
script-src https://fpjscdn.net;
connect-src https://api.fpjs.io https://*.api.fpjs.io;
worker-src blob:;
```

```text
script-src https://fpnpmcdn.net;
connect-src https://api.fpjs.io https://*.api.fpjs.io;
worker-src blob:;
```

--------------------------------

### Regional Activity Response Example

Source: https://docs.fingerprint.com/docs/drn-overview

Example response showing a device physically located in Mexico with VPN activity originating from the US.

```javascript
// Device is physically based in Mexico and is also active in the US 20% of the time via VPN.
// Its response could look like this, 
// assuming the originCountry is available 
// (if the device is using the supported version of Android SDK).
// Note that one API call response can have both "origin" and "ip" at the same time, 
// because even when the originCountry is available, we should also use the IP country 
// (to capture the fact of the VPN usage).
"regionalActivity": {
  // Use RFC 3339 format, goes 30 days back from the time request received on the server.
  // UTC time zone
  "startDate": "2023-12-16T23:12:59Z",
    // The time the request was received on the server in UTC timezone
    "endDate": "2024-01-16T23:12:59Z",
    "countries": [
        // it's clear device is based in MX physically
        {
          "code": "MX",
          "detectors": [
            { "type": "origin", "activityPercentage": 1 },
            { "type": "ip", "activityPercentage": 0.8 }
          ]
        },
        // but 20% of the time makes VPN calls out of the US IP address
        { "code": "US", "detectors": [{ "type": "ip", "activityPercentage": 0.2 }] }
      ]
}
```

--------------------------------

### GET /environments

Source: https://docs.fingerprint.com/docs/management-api

Lists all environments associated with the workspace.

```APIDOC
## GET /environments

### Description
Retrieves a list of all environments for the authenticated workspace.

### Method
GET

### Endpoint
https://management-api.fpjs.io/environments

### Request Example
curl -XGET -H 'Authorization: Bearer your-management-api-key' -H 'X-API-Version: 2024-05-20' 'https://management-api.fpjs.io/environments'

### Response
#### Success Response (200)
- **data** (array) - List of environment objects

#### Response Example
{
  "data": [
    {
      "id": "env_ff035a1dd7655da15295fa5fa89362a7",
      "name": "Default environment",
      "created_at": "2023-10-05T14:48:00.000Z"
    }
  ]
}
```

--------------------------------

### Initialize Vite Project

Source: https://docs.fingerprint.com/docs/javascript-quickstart

Commands to scaffold a new vanilla JavaScript project using Vite and install dependencies.

```bash
npm create vite@latest fingerprint-js-quickstart -- --template vanilla
cd fingerprint-js-quickstart
npm install
```

--------------------------------

### Configure Fastify Server

Source: https://docs.fingerprint.com/docs/node-server-quickstart

Create a basic server instance with a POST route for handling account creation requests.

```javascript
import Fastify from "fastify";

const app = Fastify();

app.post("/api/create-account", async (request, reply) => {
  // We'll add Fingerprint logic here
  return reply.send({ status: "Account created!" });
});

app.listen({ port: 3000 }, (err) => {
  if (err) throw err;
  console.log("Server running on http://localhost:3000");
});
```

--------------------------------

### GET /papi/v1/groups

Source: https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-papi

Retrieves the list of groups associated with the account.

```APIDOC
## GET /papi/v1/groups

### Description
Retrieves the list of groups associated with the account to identify the required groupId.

### Method
GET

### Endpoint
https://{baseURL}/papi/v1/groups

### Response
#### Success Response (200)
- **accountId** (string) - The account identifier.
- **groups** (object) - List of groups containing contractIds and groupIds.
```

--------------------------------

### GET /papi/v1/contracts

Source: https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-papi

Retrieves the list of contracts associated with the account.

```APIDOC
## GET /papi/v1/contracts

### Description
Retrieves the list of contracts associated with the account to identify the required contractId.

### Method
GET

### Endpoint
https://{baseURL}/papi/v1/contracts

### Response
#### Success Response (200)
- **accountId** (string) - The account identifier.
- **contracts** (object) - List of contracts.
```

--------------------------------

### Scaffold a new Nuxt project

Source: https://docs.fingerprint.com/docs/nuxt-quickstart

Use these commands to initialize a new Nuxt project and install dependencies.

```bash
npm create nuxt@latest fingerprint-nuxt-quickstart
cd fingerprint-nuxt-quickstart
npm install
```

--------------------------------

### GET /papi/v1/properties

Source: https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-papi

Retrieves the list of properties for a specific contract and group.

```APIDOC
## GET /papi/v1/properties

### Description
Retrieves the list of properties for a specific contract and group to identify the propertyId.

### Method
GET

### Endpoint
https://{baseURL}/papi/v1/properties

### Parameters
#### Query Parameters
- **contractId** (string) - Required - The contract identifier.
- **groupId** (string) - Required - The group identifier.

### Response
#### Success Response (200)
- **properties** (object) - List of properties including propertyId and latestVersion.
```
Tokens:
Raw