Options for FingerprintJS server API client
Delete data by visitor ID Request deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations. All delete requests are queued: Recent data (10 days or newer) belonging to the specified visitor will be deleted within 24 hours. * Data from older (11 days or more) identification events will be deleted after 90 days. If you are interested in using this API, please contact our support team to activate it for you. Otherwise, you will receive a 403.
The visitor ID you want to delete.*
Promise that resolves when the deletion request is successfully queued
client
.deleteVisitorData('<visitorId>')
.then(() => {
// Data deletion request was successfully queued
})
.catch((error) => {
if (error instanceof RequestError) {
console.log(error.statusCode, error.message)
// Access raw response in error
console.log(error.response)
if(error instanceof TooManyRequestsError) {
retryLater(error.retryAfter) // Needs to be implemented on your side
}
}
})
Retrieves a specific identification event with the information from each activated product — Identification and all active Smart signals.
identifier of the event
Related visitors API lets you link web visits and in-app browser visits that originated from the same mobile device. It searches the past 6 months of identification events to find the visitor IDs that belong to the same mobile device as the given visitor ID. ⚠️ Please note that this API is not enabled by default and is billable separately. ⚠️ If you would like to use Related visitors API, please contact our support team. To learn more, see Related visitors API reference.
Related visitors filter
The visitor ID for which you want to find the other visitor IDs that originated from the same mobile device.
client
.getRelatedVisitors({ visitor_id: '<visitorId>' })
.then((relatedVisits) => {
console.log(relatedVisits)
})
.catch((error) => {
if (error instanceof RequestError) {
console.log(error.statusCode, error.message)
// Access raw response in error
console.log(error.response)
if(error instanceof TooManyRequestsError) {
retryLater(error.retryAfter) // Needs to be implemented on your side
}
}
})
Optionalfilter: {Optionalbefore?: numberOptionallimit?: numberLimit scanned results.
For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first).
By default, the most recent 100 visits are scanned, the maximum is 500.
Optionallinked_id?: stringFilter visits by your custom identifier.
You can use [`linkedId`](https://dev.fingerprint.com/reference/get-function#linkedid) 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.
OptionalpaginationKey?: stringUse paginationKey to get the next page of results.
When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results:
1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200`
2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j`
Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned.
Optionalrequest_id?: stringFilter visits by requestId.
Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/reference/get-function#requestid). When you filter visits by `requestId`, only one visit will be returned.
Please use FingerprintJsServerApiClient.getVisits instead
Retrieves event history for the specific visitor using the given filter, returns a promise with visitor history response.
Identifier of the visitor
Optionalfilter: {Visitor history filter
Optionalbefore?: numberOptionallimit?: numberLimit scanned results.
For performance reasons, the API first scans some number of events before filtering them. Use `limit` to specify how many events are scanned before they are filtered by `requestId` or `linkedId`. Results are always returned sorted by the timestamp (most recent first).
By default, the most recent 100 visits are scanned, the maximum is 500.
Optionallinked_id?: stringFilter visits by your custom identifier.
You can use [`linkedId`](https://dev.fingerprint.com/reference/get-function#linkedid) 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.
OptionalpaginationKey?: stringUse paginationKey to get the next page of results.
When more results are available (e.g., you requested 200 results using `limit` parameter, but a total of 600 results are available), the `paginationKey` top-level attribute is added to the response. The key corresponds to the `requestId` of the last returned event. In the following request, use that value in the `paginationKey` parameter to get the next page of results:
1. First request, returning most recent 200 events: `GET api-base-url/visitors/:visitorId?limit=200`
2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/visitors/:visitorId?limit=200&paginationKey=1683900801733.Ogvu1j`
Pagination happens during scanning and before filtering, so you can get less visits than the `limit` you specified with more available on the next page. When there are no more results available for scanning, the `paginationKey` attribute is not returned.
Optionalrequest_id?: stringFilter visits by requestId.
Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/reference/get-function#requestid). When you filter visits by `requestId`, only one visit will be returned.
client
.getVisits('<visitorId>', { limit: 1 })
.then((visitorHistory) => {
console.log(visitorHistory)
})
.catch((error) => {
if (error instanceof RequestError) {
console.log(error.statusCode, error.message)
// Access raw response in error
console.log(error.response)
if(error instanceof TooManyRequestsError) {
retryLater(error.retryAfter) // Needs to be implemented on your side
}
}
})
Search for identification events, including Smart Signals, using
multiple filtering criteria. If you don't provide start or end
parameters, the default search range is the last 7 days.
Please note that events include mobile signals (e.g. rootApps) even if
the request originated from a non-mobile platform. We recommend you
ignore mobile signals for such requests.
Events filter
Optionalanti_detect_browser?: booleanOptionalbot?: "all" | "none" | "good" | "bad"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 products.botd.data.bot.result property set to a valid value are returned. Events without a products.botd Smart Signal result are left out of the response.
Optionalcloned_app?: booleanOptionalemulator?: booleanOptionalend?: numberOptionalfactory_reset?: booleanOptionalfrida?: booleanOptionalincognito?: booleanOptionalip_address?: stringOptionaljailbroken?: booleanOptionallinked_id?: stringFilter events by your custom identifier.
You can use [linked IDs](https://dev.fingerprint.com/reference/get-function#linkedid) 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.
Optionalmin_suspect_score?: numberFilter events with Suspect Score result above a provided minimum threshold.
> Note: When using this parameter, only events where the products.suspectScore.data.result property set to a value exceeding your threshold are returned. Events without a products.suspectScore Smart Signal result are left out of the response.
Optionalpagination_key?: stringUse pagination_key to get the next page of results.
When more results are available (e.g., you requested up to 200 results for your search using `limit`, but there are more than 200 events total matching your request), the `paginationKey` top-level attribute 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/search?limit=200`
2. Use `response.paginationKey` to get the next page of results: `GET api-base-url/events/search?limit=200&pagination_key=1740815825085`
Optionalprivacy_settings?: booleanOptionalreverse?: booleanOptionalroot_apps?: booleanOptionalstart?: numberOptionalsuspect?: booleanFilter 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.
Optionaltampering?: booleanOptionalvirtual_machine?: booleanOptionalvisitor_id?: stringUnique visitor identifier issued by Fingerprint Pro.
Filter for events matching this visitor_id.
Optionalvpn?: booleanOptionalvpn_confidence?: "low" | "medium" | "high,"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 products.vpn.data.confidence property set to a valid value are returned. Events without a products.vpn Smart Signal result are left out of the response.
Update an event with a given request ID
Data to update the event with.
OptionallinkedId?: stringOptionalsuspect?: booleanOptionaltag?: { [key: string]: unknown }The unique event identifier.
Change information in existing events specified by requestId or flag suspicious events.
When an event is created, it is assigned linkedId and tag submitted through the JS agent parameters. This information might not be available on the client so the Server API allows for updating the attributes after the fact.
Warning It's not possible to update events older than 10 days.
const body = {
linkedId: 'linked_id',
suspect: false,
}
client
.updateEvent(body, '<requestId>')
.then(() => {
// Event was successfully updated
})
.catch((error) => {
if (error instanceof RequestError) {
console.log(error.statusCode, error.message)
// Access raw response in error
console.log(error.response)
if(error.statusCode === 409) {
// Event is not mutable yet, wait a couple of seconds and retry the update.
}
}
})
FingerprintJS server API client used to fetch data from FingerprintJS