Server API

An efficient way to build your workflows on top of Fingerprint.js PRO data.

Regions

Server API is available in these regions: US - N.Virginia, USA EU - Frankfurt, Germany

Use these base URLs in those regions:

Region

Base URL

US

https://api.fpjs.io

EU

https://eu.api.fpjs.io

Authentication

There are 2 ways to authenticate with the API: auth header and token query parameter. All unauthenticated requests will return HTTP 403 (forbidden) response.

Auth header

This is the recommended way of API authentication. When making an API request, add Auth-Token HTTP header with your API token.

Token query parameter

This method of authentication is easy to use when you want to test it in the browser. However we don't recommend using it in production.

Example request with a token query parameter:

// Paste this URL into your browser
// replace the token with your real API token
https://api.fpjs.io/visitors/someVisitorID?token=your-api-token

API methods

get
/visitors/:id - get visitor history

api-base-url/visitors/:id
This endpoint allows you to get a history of visits with all available information. Use the visitorID as a URL path parameter.
Request
Response
Path Parameters
id
required
string
VisitorID
Query Parameters
limit
optional
integer
limit number of events returned
linked_id
optional
string
Filters events by associated linked_id value
200: OK
Visitor found.
visitor-found
visitor-found-no-visits
// visitor found and recent visits history is available
{
"visitorId": "Ibk1527CUFmcnjLwIs4A9",
"visits": [
{
"incognito": true,
"linkedId": "somelinkedId",
"time": "2019-05-21T16:40:13Z",
"url": "https://www.example.com/login",
"ip": "61.127.217.15",
"ipLocation": {
"accuracyRadius": 10,
"latitude": 49.982,
"longitude": 36.2566,
"postalCode": "61202",
"timezone": "Europe/Dusseldorf",
"city": {
"name": "Dusseldorf"
},
"continent": {
"code": "EU",
"name": "Europe"
},
"country": {
"code": "DE",
"name": "Germany"
},
"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) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.157 Safari/537.36",
"botProbability": 0
}
}
]
}
// visitor found, but has no recent visits
// by default, visits are returned from last 10 days
{
"visitorId": "Ibk1527CUFmcnjLwIs4A9",
"visits": []
}

Note that the events are sorted by the created time in descending order (recent come first). By default, the events from last 10 days are returned.