The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.
This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team.
The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.
Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.
The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.
Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry.
Event Retrieval
Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response.
Add your Secret API Key to the Authorization header using the standard Bearer format: Authorization: Bearer <secret_api_key>
Body
application/json
HTTP request metadata (including the HTTP method, headers and IP address) sent by you (your server) to the Fingerprint API for IP and bot analysis. To improve accuracy, retain as much of the original semantics of the HTTP request as possible. For example, preserve the order of the request headers and their capitalization.
At least one of ipv4_address or ipv6_address must be provided; a request with neither is rejected with a 400 error. If both IPv4 and IPv6 are provided, IP intelligence will be provided for each address. If an IPv4-mapped IPv6 address is provided in the ipv6_address request property, the IP intelligence will be provided in the ipv4_address property of the response.
headers
object[]
required
Ordered header entries from the request made to your server. Each entry represents one header line. If one header name appears as multiple lines, send each as a separate item in the array.
Headers that contain authentication or session data must still be included, but with their value set to an empty string. This includes headers like Authorization and Cookie, but may contain more depending on your specific project, for instance Proxy-Authenticate or X-Api-Key. Omitting the headers entirely changes the shape of the request and can affect detection. Never forward the real secret values.
Whenever possible, we recommend preserving header order and capitalization to provide the best accuracy, however it’s not a strict requirement if your runtime does not maintain http header order or canonicalizes header names.
The original HTTP method of the request. If supported in your runtime, preserve the original casing.
Examples:
"GET"
"POST"
"PUT"
"PATCH"
"DELETE"
url
string<uri>
required
Absolute URL of the request, without a #fragment suffix. Only HTTP and HTTPS schemes are supported.
Examples:
"http://example.com"
"https://example.com/checkout?method=card"
ipv4_address
string<ipv4>
Client IPv4 address observed by your server.
Examples:
"34.162.244.71"
"3.208.0.3"
"173.56.0.4"
ipv6_address
string<ipv6>
Client IPv6 address observed by your server.
Examples:
"2001:4860:4801:10::1"
"2600:1f42:abcd:5678:9876:fedc:1357:2468"
"2001:4868:85f:1a2b:3c4d:5e6f:7890:abcd"
"::ffff:22a2:f447"
"::ffff:34.162.244.71"
linked_id
string
A customer-provided ID that was sent with the request.
Example:
"somelinkedId"
tags
object
A customer-provided value or an object that was sent with the identification request or updated later.
Response
OK.
An event generated by the Automation Intelligence API (source is edge), containing IP and bot analysis for a request intercepted at the edge. No client-side agent is involved, so Identification (visitor_id) and Smart Signals derived from device telemetry are not available. ip_info is always present, but is empty when no IP intelligence is available for the request. environment_id is only included in webhooks, when the /edge request was authenticated with an environment-scoped secret API key. API responses (POST /v4/edge, GET /v4/events) never include it.
event_id
string
required
Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp.
Example:
"1708102555327.NLOjmg"
timestamp
integer<int64>
required
Timestamp of the event with millisecond precision in Unix time.
Example:
1708102555327
source
enum<string>
required
Identifies how the event was generated.
device - the event was generated by the JavaScript agent or a mobile SDK running on an end-user device.
edge - the event was generated by the Automation Intelligence API (/edge endpoint), analyzing a request intercepted at the edge.
Available options:
device,
edge
Allowed value: "edge"
ip_info
object
required
Details about the request IP address. Has separate fields for v4 and v6 IP address versions.
Show child attributes
linked_id
string
A customer-provided ID that was sent with the request.
Example:
"somelinkedId"
environment_id
string
Environment ID of the event.
Example:
"ae_47abaca3db2c7c43"
tags
object
A customer-provided value or an object that was sent with the identification request or updated later.
url
string
Page URL from which the request was sent.
Example:
"https://www.example.com/login"
bot_info
object
Extended bot information.
Show child attributes
proxy
boolean
IP address was used by a public proxy provider or belonged to a known recent residential proxy
proxy_confidence
enum<string>
Confidence level of the proxy detection. If a proxy is not detected, confidence is "high". If it's detected, can be "low", "medium", or "high".
Available options:
low,
medium,
high
proxy_details
object
Proxy detection details (present if proxy is true)
Show child attributes
vpn
boolean
VPN or other anonymizing service has been used when sending the request.
vpn_confidence
enum<string>
A confidence rating for the VPN detection result — "low", "medium", or "high". Depends on the combination of results returned from all VPN detection methods.
Available options:
low,
medium,
high
vpn_methods
object
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fingerprint Docs","colors":{"primary":"#FF5E24","light":"#FF5E24","dark":"#FF5E24"},"logo":{"light":"https://mintcdn.com/fingerprint/-dr70UPqCff3jq3j/logo/light.svg?fit=max\u0026auto=format\u0026n=-dr70UPqCff3jq3j\u0026q=85\u0026s=832fde6945ac7c0708a177caf225b5b7","dark":"https://mintcdn.com/fingerprint/-dr70UPqCff3jq3j/logo/dark.svg?fit=max\u0026auto=format\u0026n=-dr70UPqCff3jq3j\u0026q=85\u0026s=c2dd7579a627a978aca856ba74313219"},"favicon":"https://mintcdn.com/fingerprint/4d9So3SZdfNjiCrz/favicon.svg?fit=max\u0026auto=format\u0026n=4d9So3SZdfNjiCrz\u0026q=85\u0026s=de9f5e8612909b66cfb8730c340f397a","appearance":{"default":"light","strict":false},"background":{"color":{"light":"#F8F8F6"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.fingerprint.com/"}},"footer":{"socials":{"github":"https://github.com/fingerprintjs/fingerprintjs","x":"https://twitter.com/FingerprintJs","linkedin":"https://www.linkedin.com/company/fingerprintjs","discord":"https://discord.gg/ad6R2ttHVX"}},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":"github-dark-dimmed"},"latex":true},"integrations":{"gtm":{"tagId":"GTM-NCCSJM5"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"variables":{"FP_GO_SDK_VERSION":"8.10.1","FP_JAVA_SDK_VERSION":"8.10.0","FP_DOTNET_SDK_VERSION":"8.11.0","FP_NODE_SDK_VERSION":"7.11.0","FP_PHP_SDK_VERSION":"7.9.0","FP_PYTHON_SDK_VERSION":"9.10.0","FP_FLUTTER_SDK_VERSION":"5.2.0","FP_REACT_NATIVE_SDK_VERSION":"4.2.0","FP_IOS_SDK_VERSION":"4.3.0","FP_ANDROID_SDK_VERSION":"4.3.0"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fingerprint","hasAudioNarration":false,"actualSubdomain":"fingerprint","customDomains":["docs.fingerprint.com"],"gitSource":{"type":"github","owner":"fingerprintjs","repo":"docs","deployBranch":"main","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b008d84b09408acc2a74660","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Guides","count":125},{"language":"default","tag":"API Reference","count":87},{"language":"default","tag":"Management API","count":58},{"language":"default","tag":"Start","count":37},{"language":"default","tag":"Protect your implementation","count":34},{"language":"default","tag":"Evading ad blockers with proxy integrations","count":24},{"language":"default","tag":"API Reference (2024-05-20)","count":18},{"language":"default","tag":"Understanding Fingerprint","count":17},{"language":"default","tag":"Use Case Tutorials","count":16},{"language":"default","tag":"Identify browsers","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false,"authValue":{"userAuth":{"invalidatedAt":1767852374237,"type":"jwt","signingKeys":[{"id":"IJMx6+F/nLfCgZK3RAKTPkoMrnK6TmHLtJVAcs5SsQ0=","publicKey":"-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAErrwLrZ8uZ1VmLeSiGUk+yuPvaSJ9\nh9vVRdpTHoq2Y/ePQjOgj2utn/+JfZZF/2FcC9qa2UM+MyaXOjrKLf/j7w==\n-----END PUBLIC KEY-----\n","createdAt":1763495301098},{"id":"p1yOkvRk5lvB/Tq2NqqTOUz0ZcJaEDrI1iSjGJeV4zI=","publicKey":"-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEeISzC84hDcLFt1uEPupXdmrVsTqN\nTffn8d/nJNrsCk+XariFmUKhwZG3lZOlAShYa09MvXHA0ohKQOPabFiQ3Q==\n-----END PUBLIC KEY-----\n","createdAt":1768317895997}],"loginUrl":"https://dashboard.fingerprint.com/mintlify_login?redirectUrl=/docs/quick-start-guide"}}},"customCss":[{"filePath":"style.css","content":":root{--background-light: var(--fpds-color-gray-1);--background-dark: var(--fpds-color-gray-10);--primary: var(--fpds-color-orange-7);--primary-foreground: 60 9.1% 97.8%;--primary-hover: var(--fpds-color-orange-8);--primary-active: var(--fpds-color-orange-9);--border: var(--fpds-color-gray-3);--radius: 0.5rem;--spacing: 0.25rem;--rounded-sm: 2px;--rounded: 4px;--rounded-md: 6px;--rounded-lg: 8px;--fpds-color-gray-1: 248 248 246;--fpds-color-gray-2: 240 240 237;--fpds-color-gray-3: 228 229 225;--fpds-color-gray-4: 217 217 214;--fpds-color-gray-5: 193 193 190;--fpds-color-gray-6: 160 160 157;--fpds-color-gray-7: 140 140 137;--fpds-color-gray-8: 107 108 105;--fpds-color-gray-9: 72 73 70;--fpds-color-gray-10: 24 25 22;--fpds-color-red-1: 254 244 244;--fpds-color-red-2: 255 235 234;--fpds-color-red-3: 254 219 216;--fpds-color-red-4: 255 205 202;--fpds-color-red-5: 249 174 169;--fpds-color-red-6: 246 121 118;--fpds-color-red-7: 248 74 82;--fpds-color-red-8: 212 32 53;--fpds-color-red-9: 136 35 41;--fpds-color-red-10: 63 2 9;--fpds-color-orange-1: 253 244 241;--fpds-color-orange-2: 255 234 220;--fpds-color-orange-3: 255 221 200;--fpds-color-orange-4: 255 202 181;--fpds-color-orange-5: 254 168 140;--fpds-color-orange-6: 247 124 85;--fpds-color-orange-7: 243 91 34;--fpds-color-orange-8: 190 64 15;--fpds-color-orange-9: 119 54 28;--fpds-color-orange-10: 51 17 5;--fpds-color-yellow-1: 249 245 234;--fpds-color-yellow-2: 253 240 217;--fpds-color-yellow-3: 248 225 188;--fpds-color-yellow-4: 242 213 163;--fpds-color-yellow-5: 232 184 110;--fpds-color-yellow-6: 208 149 43;--fpds-color-yellow-7: 200 136 11;--fpds-color-yellow-8: 145 102 7;--fpds-color-yellow-9: 100 66 13;--fpds-color-yellow-10: 40 24 1;--fpds-color-green-1: 243 249 244;--fpds-color-green-2: 232 247 233;--fpds-color-green-3: 215 237 216;--fpds-color-green-4: 193 226 196;--fpds-color-green-5: 148 207 154;--fpds-color-green-6: 98 176 109;--fpds-color-green-7: 55 160 76;--fpds-color-green-8: 42 126 59;--fpds-color-green-9: 22 84 36;--fpds-color-green-10: 6 33 11;--fpds-color-teal-1: 243 251 249;--fpds-color-teal-2: 223 248 242;--fpds-color-teal-3: 203 242 233;--fpds-color-teal-4: 177 228 216;--fpds-color-teal-5: 133 206 192;--fpds-color-teal-6: 71 176 157;--fpds-color-teal-7: 49 157 140;--fpds-color-teal-8: 5 125 110;--fpds-color-teal-9: 3 83 71;--fpds-color-teal-10: 9 32 28;--fpds-color-blue-1: 243 249 254;--fpds-color-blue-2: 231 244 255;--fpds-color-blue-3: 212 236 253;--fpds-color-blue-4: 188 222 248;--fpds-color-blue-5: 139 197 243;--fpds-color-blue-6: 82 165 225;--fpds-color-blue-7: 47 148 215;--fpds-color-blue-8: 1 116 179;--fpds-color-blue-9: 10 76 123;--fpds-color-blue-10: 0 29 54;--fpds-color-purple-1: 248 247 254;--fpds-color-purple-2: 241 240 254;--fpds-color-purple-3: 230 227 253;--fpds-color-purple-4: 216 210 248;--fpds-color-purple-5: 190 180 252;--fpds-color-purple-6: 163 148 235;--fpds-color-purple-7: 144 127 218;--fpds-color-purple-8: 115 95 191;--fpds-color-purple-9: 77 59 139;--fpds-color-purple-10: 32 19 66;--fpds-color-pink-1: 254 247 249;--fpds-color-pink-2: 255 233 239;--fpds-color-pink-3: 255 220 228;--fpds-color-pink-4: 248 203 214;--fpds-color-pink-5: 246 159 184;--fpds-color-pink-6: 241 115 157;--fpds-color-pink-7: 233 88 141;--fpds-color-pink-8: 194 51 108;--fpds-color-pink-9: 139 30 74;--fpds-color-pink-10: 99 22 52;--fpds-color-white: 255 255 255;--fpds-color-black: 0 0 0;--fpds-shadow-100: 0 1px 2px 0 rgb(var(--fpds-color-gray-10) / 3%);--fpds-shadow-200: 0 1px 2px 0 rgb(var(--fpds-color-gray-10) / 5%);--fpds-shadow-300:\n 0 1px 3px 0 rgb(var(--fpds-color-gray-10) / 5%),\n 0 1px 2px -1px rgb(var(--fpds-color-gray-10) / 5%);--fpds-shadow-400:\n 0 4px 6px -1px rgb(var(--fpds-color-gray-10) / 5%),\n 0 2px 4px -2px rgb(var(--fpds-color-gray-10) / 5%);--fpds-shadow-500:\n 0 10px 15px -3px rgb(var(--fpds-color-gray-10) / 5%),\n 0 4px 6px -4px rgb(var(--fpds-color-gray-10) / 5%);--fpds-shadow-600:\n 0 20px 25px -5px rgb(var(--fpds-color-gray-10) / 5%),\n 0 8px 10px -6px rgb(var(--fpds-color-gray-10) / 5%);--fpds-shadow-700: 0 25px 50px -12px rgb(var(--fpds-color-gray-10) / 10%);--fpds-shadow-inset-100: inset 0 1px 2px 0 rgb(var(--fpds-color-gray-10) / 2%);--fpds-shadow-inset-200: inset 0 3px 3px 0 rgb(var(--fpds-color-gray-10) / 3%);--fpds-shadow-inset-300: inset 0 2px 0 0 rgb(var(--fpds-color-gray-10) / 10%);--fpds-shadow-inset-t-white-100: inset 0 1px 0 rgb(var(--fpds-color-white) / 2%);--fpds-shadow-inset-t-white-200: inset 0 1px 0 rgb(var(--fpds-color-white) / 20%);--fpds-shadow-inset-t-black-100: inset 0 1px 0 rgb(var(--fpds-color-black) / 2%);--fpds-shadow-inset-t-black-200: inset 0 1px 0 rgb(var(--fpds-color-black) / 3%);--fpds-shadow-inset-t-black-300: inset 0 1px 0 rgb(var(--fpds-color-black) / 5%);--fpds-shadow-inset-b-black-100: inset 0 -1px 0 rgb(var(--fpds-color-black) / 2%);--fpds-shadow-inset-b-black-200: inset 0 -1px 0 rgb(var(--fpds-color-black) / 3%);--fpds-shadow-button:\n var(--fpds-shadow-inset-t-white-200), var(--fpds-shadow-inset-b-black-100),\n var(--fpds-shadow-100);--gray-50: var(--fpds-color-gray-1);--gray-100: var(--fpds-color-gray-2);--gray-200: var(--fpds-color-gray-3);--gray-300: var(--fpds-color-gray-4);--gray-400: var(--fpds-color-gray-5);--gray-500: var(--fpds-color-gray-6);--gray-600: var(--fpds-color-gray-7);--gray-700: var(--fpds-color-gray-8);--gray-800: var(--fpds-color-gray-9);--gray-900: var(--fpds-color-gray-10);--gray-950: var(--fpds-color-gray-10);--red-50: var(--fpds-color-red-1);--red-100: var(--fpds-color-red-2);--red-200: var(--fpds-color-red-3);--red-300: var(--fpds-color-red-4);--red-400: var(--fpds-color-red-5);--red-500: var(--fpds-color-red-6);--red-600: var(--fpds-color-red-7);--red-700: var(--fpds-color-red-8);--red-800: var(--fpds-color-red-9);--red-900: var(--fpds-color-red-10);--orange-50: var(--fpds-color-orange-1);--orange-100: var(--fpds-color-orange-2);--orange-200: var(--fpds-color-orange-3);--orange-300: var(--fpds-color-orange-4);--orange-400: var(--fpds-color-orange-5);--orange-500: var(--fpds-color-orange-6);--orange-600: var(--fpds-color-orange-7);--orange-700: var(--fpds-color-orange-8);--orange-800: var(--fpds-color-orange-9);--orange-900: var(--fpds-color-orange-10);--yellow-50: var(--fpds-color-yellow-1);--yellow-100: var(--fpds-color-yellow-2);--yellow-200: var(--fpds-color-yellow-3);--yellow-300: var(--fpds-color-yellow-4);--yellow-400: var(--fpds-color-yellow-5);--yellow-500: var(--fpds-color-yellow-6);--yellow-600: var(--fpds-color-yellow-7);--yellow-700: var(--fpds-color-yellow-8);--yellow-800: var(--fpds-color-yellow-9);--yellow-900: var(--fpds-color-yellow-10);--green-50: var(--fpds-color-green-1);--green-100: var(--fpds-color-green-2);--green-200: var(--fpds-color-green-3);--green-300: var(--fpds-color-green-4);--green-400: var(--fpds-color-green-5);--green-500: var(--fpds-color-green-6);--green-600: var(--fpds-color-green-7);--green-700: var(--fpds-color-green-8);--green-800: var(--fpds-color-green-9);--green-900: var(--fpds-color-green-10);--teal-50: var(--fpds-color-teal-1);--teal-100: var(--fpds-color-teal-2);--teal-200: var(--fpds-color-teal-3);--teal-300: var(--fpds-color-teal-4);--teal-400: var(--fpds-color-teal-5);--teal-500: var(--fpds-color-teal-6);--teal-600: var(--fpds-color-teal-7);--teal-700: var(--fpds-color-teal-8);--teal-800: var(--fpds-color-teal-9);--teal-900: var(--fpds-color-teal-10);--blue-50: var(--fpds-color-blue-1);--blue-100: var(--fpds-color-blue-2);--blue-200: var(--fpds-color-blue-3);--blue-300: var(--fpds-color-blue-4);--blue-400: var(--fpds-color-blue-5);--blue-500: var(--fpds-color-blue-6);--blue-600: var(--fpds-color-blue-7);--blue-700: var(--fpds-color-blue-8);--blue-800: var(--fpds-color-blue-9);--blue-900: var(--fpds-color-blue-10);--purple-50: var(--fpds-color-purple-1);--purple-100: var(--fpds-color-purple-2);--purple-200: var(--fpds-color-purple-3);--purple-300: var(--fpds-color-purple-4);--purple-400: var(--fpds-color-purple-5);--purple-500: var(--fpds-color-purple-6);--purple-600: var(--fpds-color-purple-7);--purple-700: var(--fpds-color-purple-8);--purple-800: var(--fpds-color-purple-9);--purple-900: var(--fpds-color-purple-10);--pink-50: var(--fpds-color-pink-1);--pink-100: var(--fpds-color-pink-2);--pink-200: var(--fpds-color-pink-3);--pink-300: var(--fpds-color-pink-4);--pink-400: var(--fpds-color-pink-5);--pink-500: var(--fpds-color-pink-6);--pink-600: var(--fpds-color-pink-7);--pink-700: var(--fpds-color-pink-8);--pink-800: var(--fpds-color-pink-9);--pink-900: var(--fpds-color-pink-10);--white: var(--fpds-color-white);--black: var(--fpds-color-black)}.dark{--fpds-color-gray-9: 33 32 30;--default-border-color: rgb(var(--fpds-color-gray-8))}.\\[text-shadow\\:-0\\.2px_0_0_currentColor\\2c 0\\.2px_0_0_currentColor\\]{text-shadow:none}.light .border-gray-500\\/5{border-color:rgb(var(--fpds-color-gray-2))}.light .border-standard{border-color:rgb(var(--fpds-color-gray-3))}.mint-bg-green-500{background-color:rgb(var(--fpds-color-green-7))!important}.mint-bg-blue-500{background-color:rgb(var(--fpds-color-blue-7))!important}.bg-zinc-400{background-color:rgb(var(--fpds-color-gray-4))}.text-gray-500{color:rgb(var(--fpds-color-gray-8))}.text-xs{letter-spacing:-0.003em}.text-sm{letter-spacing:-0.006em}.text-base{letter-spacing:-0.011em}.text-lg{letter-spacing:-0.014em}.text-xl{letter-spacing:-0.017em}.font-semibold,.font-bold{font-weight:500}.rounded-2xl,.rounded-t-2xl,.rounded-b-2xl{border-radius:var(--rounded-lg)}.rounded-\\[14px\\]{border-radius:var(--rounded-md)}.rounded-xl,.rounded-t-xl,.rounded-b-xl{border-radius:var(--rounded)}.rounded-xt{border-radius:5px}#sidebar-content{border-color:rgb(var(--fpds-color-gray-3))}.dark #sidebar-content{border-color:rgb(var(--fpds-color-gray-9))}.sidebar-group-header{color:rgb(var(--fpds-color-gray-8));text-transform:uppercase;font-size:12px;font-weight:500;letter-spacing:0.025em}#sidebar-group li a,#sidebar-group li button{min-height:32px;gap:8px;font-weight:500;border:1px solid transparent;border-radius:var(--rounded-md)}#sidebar-group li a:hover,#sidebar-group li button:hover{background-color:rgb(var(--fpds-color-gray-2))}.dark #sidebar-group li a:hover,.dark #sidebar-group li button:hover{background-color:rgb(var(--fpds-color-gray-9))}#sidebar-group li .text-primary{background-color:rgb(var(--fpds-color-gray-2));border:1px solid rgb(var(--fpds-color-gray-4));box-shadow:var(--fpds-shadow-button);color:rgb(var(--fpds-color-gray-10))}.dark #sidebar-group li .text-primary{background-color:rgb(var(--fpds-color-gray-9));border:1px solid rgb(255 255 255/0.1);box-shadow:var(--fpds-shadow-100);color:rgb(var(--fpds-color-gray-1))}.nav-logo{width:192px;height:auto}#navbar>div:nth-child(1){background-color:rgb(var(--background-light))}.dark #navbar>div:nth-child(1){background-color:rgb(var(--background-dark))}.nav-tabs-item.group:hover .group-hover\\:bg-gray-200{background-color:transparent}.nav-tabs-item .bottom-0{height:2px}#search-bar-entry{padding-left:12px;border-radius:var(--rounded);--tw-ring-color: rgb(var(--fpds-color-gray-4));color:rgb(var(--fpds-color-gray-6));cursor:default}#search-bar-entry-mobile svg,#navbar button[aria-label=\"More actions\"] svg{width:18px!important;height:18px!important;background-color:rgb(var(--fpds-color-gray-7))!important;mask-repeat:no-repeat;mask-position:center;mask-size:contain}#search-bar-entry-mobile svg{mask-image:url('data:image/svg+xml;utf8,\u003csvg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\">\u003cpath d=\"m21 21-4.34-4.34\"/>\u003ccircle cx=\"11\" cy=\"11\" r=\"8\"/>\u003c/svg>')!important}#navbar button[aria-label=\"More actions\"] svg{mask-image:url('data:image/svg+xml;utf8,\u003csvg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\">\u003ccircle cx=\"12\" cy=\"12\" r=\"1\">\u003c/circle>\u003ccircle cx=\"12\" cy=\"5\" r=\"1\">\u003c/circle>\u003ccircle cx=\"12\" cy=\"19\" r=\"1\">\u003c/circle>\u003c/svg>')!important}.dark #search-bar-entry{padding-left:12px;border-radius:var(--rounded);--tw-ring-color: rgb(var(--fpds-color-gray-6) / 0.1);background-color:rgb(var(--fpds-color-gray-6) / 0.035)}.dark #search-bar-entry:hover{--tw-ring-color: rgb(var(--fpds-color-gray-6) / 0.125);background-color:rgb(var(--fpds-color-gray-6) / 0.045)}#topbar-cta-button a{height:32px;padding:0 10px 0 12px;background-color:rgb(var(--primary));border:1px solid rgb(var(--fpds-color-orange-8));border-radius:var(--rounded-md);box-shadow:var(--fpds-shadow-button)}#topbar-cta-button>a>span{display:none}#topbar-cta-button a:hover{background-color:rgb(var(--primary-hover))}#topbar-cta-button a:active{background-color:rgb(var(--primary-active));border-color:rgb(var(--fpds-color-orange-9));box-shadow:var(--fpds-shadow-inset-t-black-100)}#topbar-cta-button a div{gap:8px;color:rgb(var(--white))}#topbar-cta-button svg{color:rgb(var(--white));width:16px;margin-left:0;transform:scale(1.65)}#topbar-cta-button svg>path{stroke-width:1}.prose:not(.callout .prose){color:rgb(var(--fpds-color-gray-9))}.callout .prose strong{color:inherit}.dark .prose:not(.callout .prose){color:rgb(var(--fpds-color-gray-2))}.prose,.prose-gray{--tw-prose-counters: rgb(var(--fpds-color-gray-7));--tw-prose-headings: rgb(var(--fpds-color-gray-10));--tw-prose-links: rgb(var(--fpds-color-gray-10));--tw-prose-quote-borders: rgb(var(--fpds-color-gray-2));font-size:15px}.dark .prose,.dark .prose-gray{--tw-prose-counters: rgb(var(--fpds-color-gray-6));--tw-prose-headings: rgb(var(--fpds-color-gray-1));--tw-prose-links: rgb(var(--fpds-color-gray-1))}.prose ul>li:is(.dark *):before{background-color:rgb(var(--fpds-color-gray-8))}.param-head a,.param-head a:focus>div,.update a,.update a:focus>div,.prose :where(h2,h3,h4) a:focus>div{border:none}.param-head a:focus-visible div,.update a:focus-visible div,.prose :where(h2,h3,h4) a:focus-visible div{outline:none;box-shadow:0 0 0 2px rgb(var(--fpds-color-white)),\n 0 0 0 4px rgb(var(--primary));background-color:rgb(var(--fpds-color-gray-1));border:1px solid transparent}.param-head a:active div,.update a:active div,.prose :where(h2,h3,h4) a:active>div{background-color:rgb(var(--fpds-color-gray-1))}.dark .param-head a:focus-visible div,.dark .update a:focus-visible div,.dark .prose :where(h2,h3,h4) a:focus-visible div{box-shadow:0 0 0 2px rgb(var(--fpds-color-gray-10)),\n 0 0 0 4px rgb(var(--primary));background-color:rgb(var(--fpds-color-gray-9))}.dark .param-head a:active div,.dark .update a:active div,.dark .prose :where(h2,h3,h4) a:active>div{background-color:rgb(var(--fpds-color-gray-9))}.prose strong{font-weight:500}.prose code:not(pre code){background-color:rgb(var(--fpds-color-gray-2));border:1px solid rgb(var(--fpds-color-gray-3));border-radius:var(--rounded-sm);box-shadow:var(--fpds-shadow-inset-t-white-200);color:rgb(var(--fpds-color-pink-8));font-size:0.9em;font-weight:normal;padding:0.05em .5ch;word-break:break-word}.dark .prose code:not(pre code){background-color:rgb(var(--fpds-color-gray-9));border:1px solid rgb(255 255 255/0.05);box-shadow:var(--fpds-shadow-inset-t-black-200);color:rgb(var(--fpds-color-pink-6))}.prose a:not(.card,img){font-weight:inherit;border-bottom-width:1px;border-bottom-color:rgb(var(--fpds-color-gray-6));transition:ease 200ms}.prose a:hover{border-bottom-color:rgb(var(--fpds-color-gray-10))}.dark .prose a:hover{border-bottom-color:rgb(var(--fpds-color-white))}.prose h1 a,.prose h2 a,.prose h3 a,.prose h4 a{border:none}.prose a>code,.prose a:has(>code){border:none;text-decoration:none}.prose a:has(>code){color:rgb(var(--primary))}.prose th{color:rgb(var(--fpds-color-gray-8));text-transform:uppercase;font-size:12px;font-weight:500;letter-spacing:0.025em}.light .prose :where(blockquote):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){color:rgb(var(--fpds-color-gray-8))}.dark .prose blockquote:not(.not-prose){border-color:rgb(var(--fpds-color-gray-8)/.5);color:rgb(var(--fpds-color-gray-5))}summary.text-gray-600{color:rgb(var(--fpds-color-gray-8))}summary .bg-zinc-400{background-color:rgb(var(--fpds-color-gray-5))}.bg-codeblock{background-color:black}.code-block-background{--rounded-xl: 5px;background-color:rgb(var(--fpds-color-gray-10))!important}html.dark .code-block-background{background-color:rgb(var(--fpds-color-gray-9))!important}.code-block-background pre.shiki.github-light-default,.code-block-background pre.shiki.github-light-default span{color:var(--shiki-dark)!important}[data-fade-overlay]{--fade-color-light: rgb(var(--fpds-color-gray-10)) !important;--fade-color-dark: rgb(var(--fpds-color-gray-9)) !important}.code-group button .bottom-0{border-radius:0}#pagination{padding-bottom:2.5rem}#pagination svg>path{stroke-width:1.5}.light .step [data-component-part=\"step-number\"]>div{background-color:rgb(var(--fpds-color-gray-3))}.method-pill,.method-nav-pill>span,[data-component-part*=\"pill\"]{border-width:1px;border-color:rgba(0, 0, 0, 0.05);border-radius:var(--rounded);box-shadow:var(--fpds-shadow-inset-b-black-100)}.method-nav-pill{width:calc(var(--spacing) * 9)!important}.dark .method-pill,.dark .method-nav-pill>span,.dark [data-component-part*=\"pill\"]{border-color:rgba(255, 255, 255, 0.05)}[data-component-part=\"update-label\"]{border-radius:4px}[data-testid=\"api-playground-modal\"]:has([aria-label=\"Download response file\"]) [data-testid=\"code-group-select\"]{display:none}[role=\"region\"][aria-label=\"Response content\"] .shiki{color:rgb(var(--fpds-color-gray-4))}.callout{align-items:flex-start}.callout .prose{color:inherit!important}#content-area div.mdx-content .callout a{transition:none!important;font-weight:500!important}#content-area div.mdx-content .callout a:hover{color:rgb(var(--fpds-color-yellow-10))!important}.dark #content-area div.mdx-content .callout a:hover{color:rgb(var(--fpds-color-yellow-2))!important}.callout[data-callout-type=\"warning\"]{border-color:rgb(var(--fpds-color-yellow-4));background-color:rgb(var(--fpds-color-yellow-2));color:rgb(var(--fpds-color-yellow-9))}.dark .callout[data-callout-type=\"warning\"]{border-color:rgb(var(--fpds-color-yellow-7));background-color:rgb(var(--fpds-color-yellow-10));color:rgb(var(--fpds-color-yellow-1))}.callout[data-callout-type=\"note\"]{border-color:rgb(var(--fpds-color-blue-4));background-color:rgb(var(--fpds-color-blue-2));color:rgb(var(--fpds-color-blue-8))}.dark .callout[data-callout-type=\"note\"]{border-color:rgb(var(--fpds-color-blue-7));background-color:rgb(var(--fpds-color-blue-10));color:rgb(var(--fpds-color-blue-1))}.callout[data-callout-type=\"check\"]{border-color:rgb(var(--fpds-color-green-4));background-color:rgb(var(--fpds-color-green-2));color:rgb(var(--fpds-color-green-8))}.dark .callout[data-callout-type=\"check\"]{border-color:rgb(var(--fpds-color-green-7));background-color:rgb(var(--fpds-color-green-10));color:rgb(var(--fpds-color-green-1))}[data-fp-version-tag],[data-badge][data-component-part=\"version-select-tag\"][data-version-tag]{flex-shrink:0;padding:0.125rem 0.375rem;border-radius:0.375rem;background-color:hsl(60 1% 54% / 0.05);color:hsl(80 1% 42%);font-size:0.6875rem;line-height:1rem;letter-spacing:0.005em;font-weight:500}.dark [data-fp-version-tag],.dark [data-badge][data-component-part=\"version-select-tag\"][data-version-tag]{background-color:hsl(60 2% 18% / 0.1);color:hsl(60 2% 62%)}"},{"filePath":"quickstart-icons.css","content":"div:has(>img[src$=\"/icons/dotnet.svg\"]){--quickstart-icon: url('/icons/dotnet.svg')}div:has(>img[src$=\"/icons/nextjs.svg\"]){--quickstart-icon: url('/icons/nextjs.svg')}div:has(>img[src$=\"/icons/nuxt.svg\"]){--quickstart-icon: url('/icons/nuxt.svg')}div:has(>img[src$=\"/icons/preact.svg\"]){--quickstart-icon: url('/icons/preact.svg')}div:has(>img[src$=\"/icons/svelte.svg\"]){--quickstart-icon: url('/icons/svelte.svg')}div:has(>img[src$=\"/icons/dotnet.svg\"]),div:has(>img[src$=\"/icons/nextjs.svg\"]),div:has(>img[src$=\"/icons/nuxt.svg\"]),div:has(>img[src$=\"/icons/preact.svg\"]),div:has(>img[src$=\"/icons/svelte.svg\"]){position:relative}div:has(>img[src$=\"/icons/dotnet.svg\"])>img,div:has(>img[src$=\"/icons/nextjs.svg\"])>img,div:has(>img[src$=\"/icons/nuxt.svg\"])>img,div:has(>img[src$=\"/icons/preact.svg\"])>img,div:has(>img[src$=\"/icons/svelte.svg\"])>img{visibility:hidden}div:has(>img[src$=\"/icons/dotnet.svg\"])::after,div:has(>img[src$=\"/icons/nextjs.svg\"])::after,div:has(>img[src$=\"/icons/nuxt.svg\"])::after,div:has(>img[src$=\"/icons/preact.svg\"])::after,div:has(>img[src$=\"/icons/svelte.svg\"])::after{position:absolute;inset:0;content:'';background-color:rgb(193 193 190);-webkit-mask-image:var(--quickstart-icon);-webkit-mask-position:center;-webkit-mask-repeat:no-repeat;-webkit-mask-size:contain;mask-image:var(--quickstart-icon);mask-position:center;mask-repeat:no-repeat;mask-size:contain}.dark div:has(>img[src$=\"/icons/dotnet.svg\"])::after,.dark div:has(>img[src$=\"/icons/nextjs.svg\"])::after,.dark div:has(>img[src$=\"/icons/nuxt.svg\"])::after,.dark div:has(>img[src$=\"/icons/preact.svg\"])::after,.dark div:has(>img[src$=\"/icons/svelte.svg\"])::after{background-color:rgb(160 160 157)}a[aria-current=\"page\"] div:has(>img[src$=\"/icons/dotnet.svg\"])::after,a[aria-current=\"page\"] div:has(>img[src$=\"/icons/nextjs.svg\"])::after,a[aria-current=\"page\"] div:has(>img[src$=\"/icons/nuxt.svg\"])::after,a[aria-current=\"page\"] div:has(>img[src$=\"/icons/preact.svg\"])::after,a[aria-current=\"page\"] div:has(>img[src$=\"/icons/svelte.svg\"])::after{background-color:currentColor}"}]}
{"page":{"pagePath":"reference/automation-intelligence-api-collect-intelligence","slug":"/reference/automation-intelligence-api-collect-intelligence","pageMetadata":{"openapi":"post /edge","title":"Collect Intelligence","description":"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.\n\nThis feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please [contact our support team](https://fingerprint.com/support/).\n\nThe API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.\n\nAutomation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.\n\nThe API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.\n\nBecause this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via `visitor_id` and a few Smart Signals derived from deep device telemetry.\n\n### Event Retrieval\n\nEvents created by the Automation Intelligence API can be fetched via the [`/v4/events/{event_id}`](https://docs.fingerprint.com/reference/server-api-get-event) API using the `event_id` present in the API response.\n\nFetch all Automation Intelligence API events via the [`/v4/events?source=edge`](https://docs.fingerprint.com/reference/server-api-search-events#parameter-source) API.\n","href":"/reference/automation-intelligence-api-collect-intelligence"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n h3: \"h3\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please \", _jsx(_components.a, {\n href: \"https://fingerprint.com/support/\",\n children: \"contact our support team\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via \", _jsx(_components.code, {\n children: \"visitor_id\"\n }), \" and a few Smart Signals derived from deep device telemetry.\"]\n }), \"\\n\", _jsx(_components.h3, {\n children: \"Event Retrieval\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Events created by the Automation Intelligence API can be fetched via the \", _jsx(_components.a, {\n href: \"https://docs.fingerprint.com/reference/server-api-get-event\",\n children: _jsx(_components.code, {\n children: \"/v4/events/{event_id}\"\n })\n }), \" API using the \", _jsx(_components.code, {\n children: \"event_id\"\n }), \" present in the API response.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Fetch all Automation Intelligence API events via the \", _jsx(_components.a, {\n href: \"https://docs.fingerprint.com/reference/server-api-search-events#parameter-source\",\n children: _jsx(_components.code, {\n children: \"/v4/events?source=edge\"\n })\n }), \" API.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":"github-dark-dimmed"},"config":{},"pageMetadata":{"openapi":"post /edge","title":"Collect Intelligence","description":"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.\n\nThis feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please [contact our support team](https://fingerprint.com/support/).\n\nThe API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.\n\nAutomation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.\n\nThe API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.\n\nBecause this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via `visitor_id` and a few Smart Signals derived from deep device telemetry.\n\n### Event Retrieval\n\nEvents created by the Automation Intelligence API can be fetched via the [`/v4/events/{event_id}`](https://docs.fingerprint.com/reference/server-api-get-event) API using the `event_id` present in the API response.\n\nFetch all Automation Intelligence API events via the [`/v4/events?source=edge`](https://docs.fingerprint.com/reference/server-api-search-events#parameter-source) API.\n","href":"/reference/automation-intelligence-api-collect-intelligence"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fingerprint/f7a245fcbbc96c08/inkeep.js","/_mintlify/custom/fingerprint/7fefd55c8371161a/404-notificator.js","/_mintlify/custom/fingerprint/3f37b6bba42cf986/analytics.js","/_mintlify/custom/fingerprint/fd27c061b49564be/version-tag.js"],"openApiReferenceData":{"operation":{"tags":["Edge"],"operationId":"analyzeRequestForAutomationIntelligence","summary":"Collect Automation Intelligence.","description":"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.\n\nThis feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please [contact our support team](https://fingerprint.com/support/).\n\nThe API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.\n\nAutomation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.\n\nThe API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.\n\nBecause this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via `visitor_id` and a few Smart Signals derived from deep device telemetry.\n\n### Event Retrieval\n\nEvents created by the Automation Intelligence API can be fetched via the [`/v4/events/{event_id}`](https://docs.fingerprint.com/reference/server-api-get-event) API using the `event_id` present in the API response.\n\nFetch all Automation Intelligence API events via the [`/v4/events?source=edge`](https://docs.fingerprint.com/reference/server-api-search-events#parameter-source) API.\n","requestBody":"74d61f0d-1cf7-4d72-806c-0da30e0109f6","responses":{"200":"720c3fd9-4f15-4b03-b671-e0a9673c0db4","400":"1ae0a7ab-9089-44cf-a075-a00262a8fb1f","403":"1c74c86c-fb1c-4e2a-94fd-2b2cb15b4375","413":"f0fc9dc1-5f8d-417d-b253-153be359c0ee","429":"94fb7901-473e-4963-82f4-8a9182e9f10b","500":"0f9f905c-1cd5-4836-b35c-bc8be59735de"},"method":"post","type":"path","servers":["48aa7397-a848-4105-b170-b9d35845ede7","634bc208-6509-40df-ad5b-7876dcd51b2e","18012de6-6ad3-4473-a064-a150c42b016d"],"security":["2701552d-44b6-4888-b4ff-4a17f99aeb84"],"path":"/edge","baseUrlOptions":["https://api.fpjs.io/v4","https://eu.api.fpjs.io/v4","https://ap.api.fpjs.io/v4"],"title":"Collect Automation Intelligence.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"HTTP request metadata (including the HTTP method, headers and IP address) sent by you (your server) to the Fingerprint API for IP and bot analysis. To improve accuracy, retain as much of the original semantics of the HTTP request as possible. For example, preserve the order of the request headers and their capitalization.\nAt least one of `ipv4_address` or `ipv6_address` must be provided; a request with neither is rejected with a `400` error. If both IPv4 and IPv6 are provided, IP intelligence will be provided for each address. If an IPv4-mapped IPv6 address is provided in the `ipv6_address` request property, the IP intelligence will be provided in the `ipv4_address` property of the response.","additionalProperties":false,"required":["headers","method","url"],"properties":{"headers":{"type":"array","description":"Ordered header entries from the request made to your server. Each entry represents one header line. If one header name appears as multiple lines, send each as a separate item in the array.\n\nHeaders that contain authentication or session data must still be included, but with their value set to an empty string. This includes headers like `Authorization` and `Cookie`, but may contain more depending on your specific project, for instance `Proxy-Authenticate` or `X-Api-Key`. Omitting the headers entirely changes the shape of the request and can affect detection. Never forward the real secret values.\n\nWhenever possible, we recommend preserving header order and capitalization to provide the best accuracy, however it’s not a strict requirement if your runtime does not maintain http header order or canonicalizes header names.\n","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["name","value"],"properties":{"name":{"type":"string","examples":["User-Agent"],"description":"Header name as forwarded by your server. Headers must be valid according to RFC 7230 and will be canonicalized according to RFC 9112.","isRequired":true,"uniqueKey":"headers.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","examples":["Mozilla/5.0"],"description":"Value of a single forwarded header entry. Be careful to preserve the original encoding and escaping. For example, do not double escape quotes.","isRequired":true,"uniqueKey":"headers.items.[INDEX].value","typeLabel":"string"}},"uniqueKey":"headers.items.[INDEX]","typeLabel":"object"},"examples":[[{"name":"Host","value":"example.com"},{"name":"User-Agent","value":"Mozilla/5.0"},{"name":"Accept-Language","value":"en-US,en;q=0.9"}],[{"name":"Host","value":"example.com"},{"name":"User-Agent","value":"Mozilla/5.0"},{"name":"Accept-Encoding","value":"gzip"},{"name":"Accept-Encoding","value":"deflate"}]],"isRequired":true,"uniqueKey":"headers","typeLabel":"object[]"},"method":{"type":"string","description":"The original HTTP method of the request. If supported in your runtime, preserve the original casing.","examples":["GET","POST","PUT","PATCH","DELETE"],"isRequired":true,"uniqueKey":"method","typeLabel":"string"},"url":{"type":"string","description":"Absolute URL of the request, without a \\#fragment suffix. Only HTTP and HTTPS schemes are supported.","format":"uri","examples":["http://example.com","https://example.com/checkout?method=card"],"isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"ipv4_address":{"type":"string","description":"Client IPv4 address observed by your server.","format":"ipv4","examples":["34.162.244.71","3.208.0.3","173.56.0.4"],"uniqueKey":"ipv4_address","typeLabel":"string\u003cipv4>"},"ipv6_address":{"type":"string","description":"Client IPv6 address observed by your server.","format":"ipv6","examples":["2001:4860:4801:10::1","2600:1f42:abcd:5678:9876:fedc:1357:2468","2001:4868:85f:1a2b:3c4d:5e6f:7890:abcd","::ffff:22a2:f447","::ffff:34.162.244.71"],"uniqueKey":"ipv6_address","typeLabel":"string\u003cipv6>"},"linked_id":{"type":"string","examples":["somelinkedId"],"description":"A customer-provided ID that was sent with the request.","uniqueKey":"linked_id","typeLabel":"string"},"tags":{"type":"object","description":"A customer-provided value or an object that was sent with the identification request or updated later.","additionalProperties":true,"required":[],"uniqueKey":"tags","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"valid":{"title":"valid","summary":"Example request","value":{"headers":[{"name":"User-Agent","value":"Mozilla/5.0 (Local Test Bot)"},{"name":"Host","value":"example.com"},{"name":"Signature-Agent","value":"\"https://chatgpt.com\""},{"name":"Signature-Input","value":"binding0=(\"@authority\" \"signature-agent\");created=1769022347;keyid=\"otMqcjr17mGyruktGvJU8oojQTSMHlVm7uO-lrcqbdg\";alg=\"ed25519\";expires=1769022407;tag=\"web-bot-auth\""},{"name":"Signature","value":"binding0=:DLRNY0BDeHGMovOo6flKtY70U+cHa3cKDiEdLm92NGpzR0uj4m7yTHtIZnXLlHFiKjUAUBJIgbcv0HuSt8KaBg==:"}],"method":"POST","url":"https://example.com/login?foo=bar","ipv4_address":"34.162.244.71"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"720c3fd9-4f15-4b03-b671-e0a9673c0db4":{"description":"OK.","content":{"application/json":{"schema":{"type":"object","title":"Edge event","description":"An event generated by the Automation Intelligence API (`source` is `edge`), containing IP and bot analysis for a request intercepted at the edge. No client-side agent is involved, so Identification (`visitor_id`) and Smart Signals derived from device telemetry are not available. `ip_info` is always present, but is empty when no IP intelligence is available for the request. `environment_id` is only included in webhooks, when the `/edge` request was authenticated with an environment-scoped secret API key. API responses (`POST /v4/edge`, `GET /v4/events`) never include it.","additionalProperties":false,"required":["event_id","timestamp","source","ip_info"],"properties":{"event_id":{"type":"string","examples":["1708102555327.NLOjmg"],"description":"Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp.\n","isRequired":true,"uniqueKey":"event_id","typeLabel":"string"},"timestamp":{"description":"Timestamp of the event with millisecond precision in Unix time.","type":"integer","format":"int64","examples":[1708102555327],"isRequired":true,"uniqueKey":"timestamp","typeLabel":"integer\u003cint64>"},"source":{"type":"string","description":"Identifies how the event was generated.\n- `device` - the event was generated by the JavaScript agent or a mobile SDK running on an end-user device.\n- `edge` - the event was generated by the Automation Intelligence API (`/edge` endpoint), analyzing a request intercepted at the edge.\n","enum":["device","edge"],"const":"edge","isRequired":true,"uniqueKey":"source","typeLabel":"enum\u003cstring>"},"ip_info":{"type":"object","description":"Details about the request IP address. Has separate fields for v4 and v6 IP address versions.","additionalProperties":false,"required":[],"properties":{"v4":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"string","format":"ipv4","examples":["94.142.239.124"],"isRequired":true,"uniqueKey":"ip_info.v4.address","typeLabel":"string\u003cipv4>"},"geolocation":{"type":"object","additionalProperties":false,"required":[],"properties":{"accuracy_radius":{"type":"integer","examples":[20],"minimum":0,"description":"The IP address is likely to be within this radius (in km) of the specified location.","uniqueKey":"ip_info.v4.geolocation.accuracy_radius","typeLabel":"integer"},"latitude":{"type":"number","format":"double","examples":[50.05],"minimum":-90,"maximum":90,"uniqueKey":"ip_info.v4.geolocation.latitude","typeLabel":"number\u003cdouble>"},"longitude":{"type":"number","format":"double","examples":[14.4],"minimum":-180,"maximum":180,"uniqueKey":"ip_info.v4.geolocation.longitude","typeLabel":"number\u003cdouble>"},"postal_code":{"type":"string","examples":["150 00"],"uniqueKey":"ip_info.v4.geolocation.postal_code","typeLabel":"string"},"timezone":{"type":"string","format":"timezone","examples":["Europe/Prague"],"uniqueKey":"ip_info.v4.geolocation.timezone","typeLabel":"string\u003ctimezone>"},"city_name":{"type":"string","examples":["Prague"],"uniqueKey":"ip_info.v4.geolocation.city_name","typeLabel":"string"},"country_code":{"type":"string","examples":["CZ"],"minLength":2,"maxLength":2,"uniqueKey":"ip_info.v4.geolocation.country_code","typeLabel":"string"},"country_name":{"type":"string","examples":["Czechia"],"uniqueKey":"ip_info.v4.geolocation.country_name","typeLabel":"string"},"continent_code":{"type":"string","examples":["EU"],"minLength":2,"maxLength":2,"uniqueKey":"ip_info.v4.geolocation.continent_code","typeLabel":"string"},"continent_name":{"type":"string","examples":["Europe"],"uniqueKey":"ip_info.v4.geolocation.continent_name","typeLabel":"string"},"subdivisions":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["iso_code","name"],"properties":{"iso_code":{"type":"string","examples":["10"],"isRequired":true,"uniqueKey":"ip_info.v4.geolocation.subdivisions.items.[INDEX].iso_code","typeLabel":"string"},"name":{"type":"string","examples":["Hlavni mesto Praha"],"isRequired":true,"uniqueKey":"ip_info.v4.geolocation.subdivisions.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"ip_info.v4.geolocation.subdivisions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"ip_info.v4.geolocation.subdivisions","typeLabel":"object[]"}},"uniqueKey":"ip_info.v4.geolocation","typeLabel":"object"},"asn":{"type":"string","examples":["396982","16509","701"],"uniqueKey":"ip_info.v4.asn","typeLabel":"string"},"asn_name":{"type":"string","examples":["Google LLC","Amazon.com, Inc.","Verizon Business"],"uniqueKey":"ip_info.v4.asn_name","typeLabel":"string"},"asn_network":{"type":"string","examples":["34.160.0.0/12","3.208.0.0/12","173.56.0.0/16"],"uniqueKey":"ip_info.v4.asn_network","typeLabel":"string"},"asn_type":{"type":"string","examples":["hosting","isp","business","education"],"uniqueKey":"ip_info.v4.asn_type","typeLabel":"string"},"datacenter_result":{"type":"boolean","description":"When true, the request originated from a datacenter.","uniqueKey":"ip_info.v4.datacenter_result","typeLabel":"boolean"},"datacenter_name":{"type":"string","examples":["Google Cloud","Amazon AWS"],"uniqueKey":"ip_info.v4.datacenter_name","typeLabel":"string"}},"uniqueKey":"ip_info.v4","typeLabel":"object"},"v6":{"type":"object","additionalProperties":false,"required":["address"],"properties":{"address":{"type":"string","format":"ipv6","examples":["2001:db8:3333:4444:5555:6666:7777:8888"],"isRequired":true,"uniqueKey":"ip_info.v6.address","typeLabel":"string\u003cipv6>"},"geolocation":{"type":"object","additionalProperties":false,"required":[],"properties":{"accuracy_radius":{"type":"integer","examples":[20],"minimum":0,"description":"The IP address is likely to be within this radius (in km) of the specified location.","uniqueKey":"ip_info.v6.geolocation.accuracy_radius","typeLabel":"integer"},"latitude":{"type":"number","format":"double","examples":[50.05],"minimum":-90,"maximum":90,"uniqueKey":"ip_info.v6.geolocation.latitude","typeLabel":"number\u003cdouble>"},"longitude":{"type":"number","format":"double","examples":[14.4],"minimum":-180,"maximum":180,"uniqueKey":"ip_info.v6.geolocation.longitude","typeLabel":"number\u003cdouble>"},"postal_code":{"type":"string","examples":["150 00"],"uniqueKey":"ip_info.v6.geolocation.postal_code","typeLabel":"string"},"timezone":{"type":"string","format":"timezone","examples":["Europe/Prague"],"uniqueKey":"ip_info.v6.geolocation.timezone","typeLabel":"string\u003ctimezone>"},"city_name":{"type":"string","examples":["Prague"],"uniqueKey":"ip_info.v6.geolocation.city_name","typeLabel":"string"},"country_code":{"type":"string","examples":["CZ"],"minLength":2,"maxLength":2,"uniqueKey":"ip_info.v6.geolocation.country_code","typeLabel":"string"},"country_name":{"type":"string","examples":["Czechia"],"uniqueKey":"ip_info.v6.geolocation.country_name","typeLabel":"string"},"continent_code":{"type":"string","examples":["EU"],"minLength":2,"maxLength":2,"uniqueKey":"ip_info.v6.geolocation.continent_code","typeLabel":"string"},"continent_name":{"type":"string","examples":["Europe"],"uniqueKey":"ip_info.v6.geolocation.continent_name","typeLabel":"string"},"subdivisions":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["iso_code","name"],"properties":{"iso_code":{"type":"string","examples":["10"],"isRequired":true,"uniqueKey":"ip_info.v6.geolocation.subdivisions.items.[INDEX].iso_code","typeLabel":"string"},"name":{"type":"string","examples":["Hlavni mesto Praha"],"isRequired":true,"uniqueKey":"ip_info.v6.geolocation.subdivisions.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"ip_info.v6.geolocation.subdivisions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"ip_info.v6.geolocation.subdivisions","typeLabel":"object[]"}},"uniqueKey":"ip_info.v6.geolocation","typeLabel":"object"},"asn":{"type":"string","examples":["396982","16509","701"],"uniqueKey":"ip_info.v6.asn","typeLabel":"string"},"asn_name":{"type":"string","examples":["Google LLC","Amazon.com, Inc.","Verizon Business"],"uniqueKey":"ip_info.v6.asn_name","typeLabel":"string"},"asn_network":{"type":"string","examples":["2001:4860:4801:10::/64","2600:1f00::/24","2001:4868:800::/40"],"uniqueKey":"ip_info.v6.asn_network","typeLabel":"string"},"asn_type":{"type":"string","examples":["hosting","isp","business","education"],"uniqueKey":"ip_info.v6.asn_type","typeLabel":"string"},"datacenter_result":{"type":"boolean","description":"When true, the request originated from a datacenter.","uniqueKey":"ip_info.v6.datacenter_result","typeLabel":"boolean"},"datacenter_name":{"type":"string","examples":["Google Cloud","Amazon AWS"],"uniqueKey":"ip_info.v6.datacenter_name","typeLabel":"string"}},"uniqueKey":"ip_info.v6","typeLabel":"object"}},"isRequired":true,"uniqueKey":"ip_info","typeLabel":"object"},"linked_id":{"type":"string","examples":["somelinkedId"],"description":"A customer-provided ID that was sent with the request.","uniqueKey":"linked_id","typeLabel":"string"},"environment_id":{"type":"string","examples":["ae_47abaca3db2c7c43"],"description":"Environment ID of the event.","uniqueKey":"environment_id","typeLabel":"string"},"tags":{"type":"object","description":"A customer-provided value or an object that was sent with the identification request or updated later.","additionalProperties":true,"required":[],"uniqueKey":"tags","typeLabel":"object"},"url":{"type":"string","examples":["https://www.example.com/login"],"description":"Page URL from which the request was sent.","uniqueKey":"url","typeLabel":"string"},"bot_info":{"type":"object","description":"Extended bot information.","additionalProperties":false,"required":["category","provider","name","identity","confidence"],"properties":{"category":{"type":"string","enum":["advertising_and_marketing","aggregator","ai_agent","ai_assistant","ai_browser","ai_crawler","ai_search","browser_automation","ecommerce","monitoring_and_analytics","other","scraping","security","search_engine_crawler","search_engine_optimization","unknown"],"description":"The type and purpose of the bot.\n","isRequired":true,"uniqueKey":"bot_info.category","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"The organization or company operating the bot.","examples":["Anthropic","Browserbase","Google","OpenAI"],"isRequired":true,"uniqueKey":"bot_info.provider","typeLabel":"string"},"name":{"type":"string","description":"The specific name or identifier of the bot.","examples":["ClaudeBot","Browserbase Agent","Googlebot","GPTBot","ChatGPT-User"],"isRequired":true,"uniqueKey":"bot_info.name","typeLabel":"string"},"identity":{"type":"string","enum":["verified","signed","spoofed","unknown"],"description":"The verification status of the bot's identity:\n * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider.\n * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider's customers.\n * `spoofed` - bot that claims a public identity but fails verification.\n * `unknown` - bot that does not publish a verifiable identity.\n","isRequired":true,"uniqueKey":"bot_info.identity","typeLabel":"enum\u003cstring>"},"confidence":{"type":"string","enum":["low","medium","high"],"description":"Confidence level of the bot identification.","isRequired":true,"uniqueKey":"bot_info.confidence","typeLabel":"enum\u003cstring>"},"provider_url":{"type":"string","examples":["https://chatgpt.com"],"description":"The URL of the bot provider's website.","uniqueKey":"bot_info.provider_url","typeLabel":"string"}},"uniqueKey":"bot_info","typeLabel":"object"},"proxy":{"type":"boolean","description":"IP address was used by a public proxy provider or belonged to a known recent residential proxy\n","uniqueKey":"proxy","typeLabel":"boolean"},"proxy_confidence":{"type":"string","enum":["low","medium","high"],"description":"Confidence level of the proxy detection. If a proxy is not detected, confidence is \"high\". If it's detected, can be \"low\", \"medium\", or \"high\".\n","uniqueKey":"proxy_confidence","typeLabel":"enum\u003cstring>"},"proxy_details":{"type":"object","additionalProperties":false,"description":"Proxy detection details (present if `proxy` is `true`)","required":["proxy_type"],"properties":{"proxy_type":{"type":"string","enum":["residential","data_center","unknown"],"description":"Proxy type:\n * `residential` - proxies that route through residential and telecom IP addresses to appear as legitimate traffic\n * `data_center` - proxies which route through data centers\n * `unknown` - reported when a proxy is detected solely by the ML model and the IP sources did not determine a specific type\n","isRequired":true,"uniqueKey":"proxy_details.proxy_type","typeLabel":"enum\u003cstring>"},"last_seen_at":{"type":"integer","format":"int64","examples":[1708102555327],"description":"Unix millisecond timestamp with hourly resolution of when this IP was last seen as a proxy\n","uniqueKey":"proxy_details.last_seen_at","typeLabel":"integer\u003cint64>"},"provider":{"type":"string","examples":["Massive"],"description":"String representing the last proxy service provider detected when this\nIP was synced. An IP can be shared by multiple service providers.\n","uniqueKey":"proxy_details.provider","typeLabel":"string"}},"uniqueKey":"proxy_details","typeLabel":"object"},"vpn":{"type":"boolean","description":"VPN or other anonymizing service has been used when sending the request.\n","uniqueKey":"vpn","typeLabel":"boolean"},"vpn_confidence":{"type":"string","enum":["low","medium","high"],"description":"A confidence rating for the VPN detection result — \"low\", \"medium\", or \"high\". Depends on the combination of results returned from all VPN detection methods.","uniqueKey":"vpn_confidence","typeLabel":"enum\u003cstring>"},"vpn_methods":{"type":"object","additionalProperties":false,"required":[],"properties":{"timezone_mismatch":{"type":"boolean","x-platforms":["android","ios","browser"],"description":"The browser timezone doesn't match the timezone inferred from the request IP address.","uniqueKey":"vpn_methods.timezone_mismatch","typeLabel":"boolean"},"public_vpn":{"type":"boolean","x-platforms":["android","ios","browser"],"description":"Request IP address is owned and used by a public VPN service provider.","uniqueKey":"vpn_methods.public_vpn","typeLabel":"boolean"},"auxiliary_mobile":{"type":"boolean","x-platforms":["android","ios","browser"],"description":"This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices.","uniqueKey":"vpn_methods.auxiliary_mobile","typeLabel":"boolean"},"os_mismatch":{"type":"boolean","x-platforms":["browser"],"description":"The browser runs on a different operating system than the operating system inferred from the request network signature.","uniqueKey":"vpn_methods.os_mismatch","typeLabel":"boolean"},"relay":{"type":"boolean","x-platforms":["android","ios","browser"],"description":"Request IP address belongs to a relay service provider, indicating the use of relay services like [Apple Private relay](https://support.apple.com/en-us/102602) or [Cloudflare Warp](https://developers.cloudflare.com/warp-client/).\n\n* Like VPNs, relay services anonymize the visitor's true IP address.\n* Unlike traditional VPNs, relay services don't let visitors spoof their location by choosing an exit node in a different country.\n\nThis field allows you to differentiate VPN users and relay service users in your fraud prevention logic.\n","uniqueKey":"vpn_methods.relay","typeLabel":"boolean"},"ml_prediction":{"type":"boolean","x-platforms":["browser"],"description":"`true` if the request came from a device running a VPN, `false` otherwise. \n","uniqueKey":"vpn_methods.ml_prediction","typeLabel":"boolean"}},"uniqueKey":"vpn_methods","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Edge event · object"},"examples":{"200-ok-bot-detected":{"title":"200-ok-bot-detected","summary":"Example response when a bot was detected.","value":{"event_id":"1758130560902.8tRtrH","timestamp":1758130560902,"source":"edge","url":"https://example.com/login?foo=bar","bot_info":{"category":"ai_agent","provider":"OpenAI","provider_url":"https://openai.com","name":"ChatGPT Agent","identity":"signed","confidence":"high"},"ip_info":{"v4":{"address":"104.210.139.192","geolocation":{"accuracy_radius":20,"latitude":29.42412,"longitude":-98.49363,"postal_code":"78205","timezone":"America/Chicago","city_name":"San Antonio","country_code":"US","country_name":"United States","continent_code":"NA","continent_name":"North America","subdivisions":[{"iso_code":"TX","name":"Texas"}]},"asn":"8075","asn_name":"Microsoft Corporation","asn_network":"104.208.0.0/13","asn_type":"hosting","datacenter_result":true,"datacenter_name":"Microsoft Azure"}},"proxy":false,"proxy_confidence":"high","vpn":false,"vpn_confidence":"medium","vpn_methods":{"public_vpn":false,"relay":false}}},"200-ok-bot-not-detected":{"title":"200-ok-bot-not-detected","summary":"Example response when a bot was not detected.","value":{"event_id":"1758130561034.Kp2Wqz","timestamp":1758130561034,"source":"edge","url":"https://example.com/login?foo=bar","ip_info":{"v4":{"address":"173.56.25.103","geolocation":{"accuracy_radius":20,"latitude":40.71427,"longitude":-74.00597,"postal_code":"10001","timezone":"America/New_York","city_name":"New York City","country_code":"US","country_name":"United States","continent_code":"NA","continent_name":"North America","subdivisions":[{"iso_code":"NY","name":"New York"}]},"asn":"701","asn_name":"Verizon Business","asn_network":"173.56.0.0/16","asn_type":"isp","datacenter_result":false}},"proxy":false,"proxy_confidence":"high","vpn":false,"vpn_confidence":"medium","vpn_methods":{"public_vpn":false,"relay":false}}},"200-ok-proxy-detected":{"title":"200-ok-proxy-detected","summary":"Example response when a proxy was detected.","value":{"event_id":"1758130561187.Rm9Vxd","timestamp":1758130561187,"source":"edge","url":"https://example.com/login?foo=bar","ip_info":{"v4":{"address":"173.56.25.103","geolocation":{"accuracy_radius":20,"latitude":40.71427,"longitude":-74.00597,"postal_code":"10001","timezone":"America/New_York","city_name":"New York City","country_code":"US","country_name":"United States","continent_code":"NA","continent_name":"North America","subdivisions":[{"iso_code":"NY","name":"New York"}]},"asn":"701","asn_name":"Verizon Business","asn_network":"173.56.0.0/16","asn_type":"isp","datacenter_result":false}},"proxy":true,"proxy_confidence":"high","proxy_details":{"proxy_type":"data_center","last_seen_at":1716057600000,"provider":"DataImpulse"},"vpn":false,"vpn_confidence":"medium","vpn_methods":{"public_vpn":false,"relay":false}}}},"exampleType":"examples"}},"exampleType":"examples"},"1ae0a7ab-9089-44cf-a075-a00262a8fb1f":{"description":"Bad request. The request payload is not valid.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["request_cannot_be_parsed","request_read_timeout","secret_api_key_required","secret_api_key_not_found","public_api_key_required","public_api_key_not_found","subscription_not_active","wrong_region","feature_not_enabled","visitor_not_found","too_many_requests","state_not_ready","failed","event_not_found","missing_module","payload_too_large","service_unavailable","ruleset_not_found"],"description":"Error code:\n* `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors\n that prevented us from parsing it (wrong type/surpassed limits).\n* `request_read_timeout` - The request body could not be read before the connection timed out.\n* `secret_api_key_required` - secret API key in header is missing or empty.\n* `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.\n* `public_api_key_required` - public API key in header is missing or empty.\n* `public_api_key_not_found` - No Fingerprint workspace found for specified public API key.\n* `subscription_not_active` - Fingerprint workspace is not active.\n* `wrong_region` - Server and workspace region differ.\n* `feature_not_enabled` - This feature (for example, Delete API) is not enabled for your workspace.\n* `visitor_not_found` - The specified visitor ID was not found. It never existed or it may have already been deleted.\n* `too_many_requests` - The limit on secret API key requests per second has been exceeded.\n* `state_not_ready` - The event specified with event ID is\n not ready for updates yet. Try again.\n This error happens in rare cases when update API is called immediately\n after receiving the event ID on the client. In case you need to send\n information right away, we recommend using the JavaScript agent API instead.\n* `failed` - Internal server error.\n* `event_not_found` - The specified event ID was not found. It never existed, expired, or it has been deleted.\n* `missing_module` - The request is invalid because it is missing a required module.\n* `payload_too_large` - The request payload is too large and cannot be processed.\n* `service_unavailable` - The service was unable to process the request.\n* `ruleset_not_found` - The specified ruleset was not found. It never existed or it has been deleted.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","examples":["Forbidden"],"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"400-unknown-field":{"title":"400-unknown-field","summary":"Error response when an unknown field is provided.","value":{"error":{"code":"request_cannot_be_parsed","message":"request body contains an unknown field \"unknown\""}}},"400-ip-required":{"title":"400-ip-required","summary":"Error response when an IP address was not provided.","value":{"error":{"code":"request_cannot_be_parsed","message":"at least one of ipv4_address or ipv6_address is required"}}},"400-read-timeout":{"title":"400-read-timeout","summary":"Error response if the request is not sent within 5 seconds.","value":{"error":{"code":"request_read_timeout","message":"request read timeout"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1c74c86c-fb1c-4e2a-94fd-2b2cb15b4375":{"description":"Forbidden. Access to this API is denied.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["request_cannot_be_parsed","request_read_timeout","secret_api_key_required","secret_api_key_not_found","public_api_key_required","public_api_key_not_found","subscription_not_active","wrong_region","feature_not_enabled","visitor_not_found","too_many_requests","state_not_ready","failed","event_not_found","missing_module","payload_too_large","service_unavailable","ruleset_not_found"],"description":"Error code:\n* `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors\n that prevented us from parsing it (wrong type/surpassed limits).\n* `request_read_timeout` - The request body could not be read before the connection timed out.\n* `secret_api_key_required` - secret API key in header is missing or empty.\n* `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.\n* `public_api_key_required` - public API key in header is missing or empty.\n* `public_api_key_not_found` - No Fingerprint workspace found for specified public API key.\n* `subscription_not_active` - Fingerprint workspace is not active.\n* `wrong_region` - Server and workspace region differ.\n* `feature_not_enabled` - This feature (for example, Delete API) is not enabled for your workspace.\n* `visitor_not_found` - The specified visitor ID was not found. It never existed or it may have already been deleted.\n* `too_many_requests` - The limit on secret API key requests per second has been exceeded.\n* `state_not_ready` - The event specified with event ID is\n not ready for updates yet. Try again.\n This error happens in rare cases when update API is called immediately\n after receiving the event ID on the client. In case you need to send\n information right away, we recommend using the JavaScript agent API instead.\n* `failed` - Internal server error.\n* `event_not_found` - The specified event ID was not found. It never existed, expired, or it has been deleted.\n* `missing_module` - The request is invalid because it is missing a required module.\n* `payload_too_large` - The request payload is too large and cannot be processed.\n* `service_unavailable` - The service was unable to process the request.\n* `ruleset_not_found` - The specified ruleset was not found. It never existed or it has been deleted.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","examples":["Forbidden"],"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"403-secret-api-key-required":{"title":"403-secret-api-key-required","summary":"Error response when the secret API key was not provided.","value":{"error":{"code":"secret_api_key_required","message":"secret API key in header is missing or empty"}}},"403-secret-api-key-not-found":{"title":"403-secret-api-key-not-found","summary":"Error response when the provided secret API key does not exist.","value":{"error":{"code":"secret_api_key_not_found","message":"no fingerprint workspace found for specified secret API key"}}},"403-wrong-region":{"title":"403-wrong-region","summary":"Error response when the API region is different from the region, the calling workspace is configured with.","value":{"error":{"code":"wrong_region","message":"wrong region"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f0fc9dc1-5f8d-417d-b253-153be359c0ee":{"description":"Bad request. The request payload is too large.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["request_cannot_be_parsed","request_read_timeout","secret_api_key_required","secret_api_key_not_found","public_api_key_required","public_api_key_not_found","subscription_not_active","wrong_region","feature_not_enabled","visitor_not_found","too_many_requests","state_not_ready","failed","event_not_found","missing_module","payload_too_large","service_unavailable","ruleset_not_found"],"description":"Error code:\n* `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors\n that prevented us from parsing it (wrong type/surpassed limits).\n* `request_read_timeout` - The request body could not be read before the connection timed out.\n* `secret_api_key_required` - secret API key in header is missing or empty.\n* `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.\n* `public_api_key_required` - public API key in header is missing or empty.\n* `public_api_key_not_found` - No Fingerprint workspace found for specified public API key.\n* `subscription_not_active` - Fingerprint workspace is not active.\n* `wrong_region` - Server and workspace region differ.\n* `feature_not_enabled` - This feature (for example, Delete API) is not enabled for your workspace.\n* `visitor_not_found` - The specified visitor ID was not found. It never existed or it may have already been deleted.\n* `too_many_requests` - The limit on secret API key requests per second has been exceeded.\n* `state_not_ready` - The event specified with event ID is\n not ready for updates yet. Try again.\n This error happens in rare cases when update API is called immediately\n after receiving the event ID on the client. In case you need to send\n information right away, we recommend using the JavaScript agent API instead.\n* `failed` - Internal server error.\n* `event_not_found` - The specified event ID was not found. It never existed, expired, or it has been deleted.\n* `missing_module` - The request is invalid because it is missing a required module.\n* `payload_too_large` - The request payload is too large and cannot be processed.\n* `service_unavailable` - The service was unable to process the request.\n* `ruleset_not_found` - The specified ruleset was not found. It never existed or it has been deleted.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","examples":["Forbidden"],"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"413":{"title":"413","summary":"Payload too large error","value":{"error":{"code":"payload_too_large","message":"payload too large"}}}},"exampleType":"examples"}},"exampleType":"examples"},"94fb7901-473e-4963-82f4-8a9182e9f10b":{"description":"Too Many Requests. The request is throttled.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["request_cannot_be_parsed","request_read_timeout","secret_api_key_required","secret_api_key_not_found","public_api_key_required","public_api_key_not_found","subscription_not_active","wrong_region","feature_not_enabled","visitor_not_found","too_many_requests","state_not_ready","failed","event_not_found","missing_module","payload_too_large","service_unavailable","ruleset_not_found"],"description":"Error code:\n* `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors\n that prevented us from parsing it (wrong type/surpassed limits).\n* `request_read_timeout` - The request body could not be read before the connection timed out.\n* `secret_api_key_required` - secret API key in header is missing or empty.\n* `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.\n* `public_api_key_required` - public API key in header is missing or empty.\n* `public_api_key_not_found` - No Fingerprint workspace found for specified public API key.\n* `subscription_not_active` - Fingerprint workspace is not active.\n* `wrong_region` - Server and workspace region differ.\n* `feature_not_enabled` - This feature (for example, Delete API) is not enabled for your workspace.\n* `visitor_not_found` - The specified visitor ID was not found. It never existed or it may have already been deleted.\n* `too_many_requests` - The limit on secret API key requests per second has been exceeded.\n* `state_not_ready` - The event specified with event ID is\n not ready for updates yet. Try again.\n This error happens in rare cases when update API is called immediately\n after receiving the event ID on the client. In case you need to send\n information right away, we recommend using the JavaScript agent API instead.\n* `failed` - Internal server error.\n* `event_not_found` - The specified event ID was not found. It never existed, expired, or it has been deleted.\n* `missing_module` - The request is invalid because it is missing a required module.\n* `payload_too_large` - The request payload is too large and cannot be processed.\n* `service_unavailable` - The service was unable to process the request.\n* `ruleset_not_found` - The specified ruleset was not found. It never existed or it has been deleted.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","examples":["Forbidden"],"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"429-too-many-requests-error":{"title":"429-too-many-requests-error","summary":"Too many requests error","value":{"error":{"code":"too_many_requests","message":"too many requests"}}}},"exampleType":"examples"}},"exampleType":"examples"},"0f9f905c-1cd5-4836-b35c-bc8be59735de":{"description":"Workspace error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","message"],"properties":{"code":{"type":"string","enum":["request_cannot_be_parsed","request_read_timeout","secret_api_key_required","secret_api_key_not_found","public_api_key_required","public_api_key_not_found","subscription_not_active","wrong_region","feature_not_enabled","visitor_not_found","too_many_requests","state_not_ready","failed","event_not_found","missing_module","payload_too_large","service_unavailable","ruleset_not_found"],"description":"Error code:\n* `request_cannot_be_parsed` - The query parameters or JSON payload contains some errors\n that prevented us from parsing it (wrong type/surpassed limits).\n* `request_read_timeout` - The request body could not be read before the connection timed out.\n* `secret_api_key_required` - secret API key in header is missing or empty.\n* `secret_api_key_not_found` - No Fingerprint workspace found for specified secret API key.\n* `public_api_key_required` - public API key in header is missing or empty.\n* `public_api_key_not_found` - No Fingerprint workspace found for specified public API key.\n* `subscription_not_active` - Fingerprint workspace is not active.\n* `wrong_region` - Server and workspace region differ.\n* `feature_not_enabled` - This feature (for example, Delete API) is not enabled for your workspace.\n* `visitor_not_found` - The specified visitor ID was not found. It never existed or it may have already been deleted.\n* `too_many_requests` - The limit on secret API key requests per second has been exceeded.\n* `state_not_ready` - The event specified with event ID is\n not ready for updates yet. Try again.\n This error happens in rare cases when update API is called immediately\n after receiving the event ID on the client. In case you need to send\n information right away, we recommend using the JavaScript agent API instead.\n* `failed` - Internal server error.\n* `event_not_found` - The specified event ID was not found. It never existed, expired, or it has been deleted.\n* `missing_module` - The request is invalid because it is missing a required module.\n* `payload_too_large` - The request payload is too large and cannot be processed.\n* `service_unavailable` - The service was unable to process the request.\n* `ruleset_not_found` - The specified ruleset was not found. It never existed or it has been deleted.\n","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","examples":["Forbidden"],"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"request_cannot_be_parsed","message":"Forbidden"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"2701552d-44b6-4888-b4ff-4a17f99aeb84":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"string","description":"Add your Secret API Key to the Authorization header using the standard Bearer format: `Authorization: Bearer \u003csecret_api_key>`","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"48aa7397-a848-4105-b170-b9d35845ede7":{"url":"https://api.fpjs.io/v4","description":"Global"},"634bc208-6509-40df-ad5b-7876dcd51b2e":{"url":"https://eu.api.fpjs.io/v4","description":"EU"},"18012de6-6ad3-4473-a064-a150c42b016d":{"url":"https://ap.api.fpjs.io/v4","description":"Asia (Mumbai)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"string","description":"Add your Secret API Key to the Authorization header using the standard Bearer format: `Authorization: Bearer \u003csecret_api_key>`","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Add your Secret API Key to the Authorization header using the standard Bearer format: `Authorization: Bearer \u003csecret_api_key>`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"reference/fingerprint-server-api-readme-explorer.yaml"},"subdomain":"fingerprint","siteName":"Fingerprint Docs","title":"Collect Intelligence - Fingerprint Docs","lastModified":"2026-08-22T02:25:53.995Z","originalFileLocation":"reference/automation-intelligence-api-collect-intelligence.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application. This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team. The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection. Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context. The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend. Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry. ### Event Retrieval Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response. Fetch all Automation Intelligence API events via the /v4/events?source=edge API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fingerprint Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Collect Intelligence - Fingerprint Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application. This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team. The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection. Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context. The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend. Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry. ### Event Retrieval Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response. Fetch all Automation Intelligence API events via the /v4/events?source=edge API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fingerprint Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fingerprint.mintlify.site/_mintlify/api/og/v2?division=Automation+Intelligence+API\u0026amp;title=Collect+Intelligence\u0026amp;description=The+Automation+Intelligence+API+gives+you+the+tools+to+determine+whether+traffic+is+legitimate+and+should+be+accepted+by+your+application.%0A%0AThis+feature+is+curr\u0026amp;theme=af51cd51c485628a9b4b75fc\u0026amp;signature=e5f5ea47eb3782c5fab6901d508c2db03391dcb043af9541a4a97c1ad90527c6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Collect Intelligence - Fingerprint Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application. This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team. The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection. Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context. The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend. Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry. ### Event Retrieval Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response. Fetch all Automation Intelligence API events via the /v4/events?source=edge API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fingerprint.mintlify.site/_mintlify/api/og/v2?division=Automation+Intelligence+API\u0026amp;title=Collect+Intelligence\u0026amp;description=The+Automation+Intelligence+API+gives+you+the+tools+to+determine+whether+traffic+is+legitimate+and+should+be+accepted+by+your+application.%0A%0AThis+feature+is+curr\u0026amp;theme=af51cd51c485628a9b4b75fc\u0026amp;signature=e5f5ea47eb3782c5fab6901d508c2db03391dcb043af9541a4a97c1ad90527c6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fingerprint/iqdp3t97rYYPddeI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fingerprint Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5E24\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/automation-intelligence-api-collect-intelligence.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fingerprint.com/#organization\",\"name\":\"Fingerprint Docs\",\"url\":\"https://docs.fingerprint.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fingerprint/-dr70UPqCff3jq3j/logo/light.svg?fit=max\u0026auto=format\u0026n=-dr70UPqCff3jq3j\u0026q=85\u0026s=832fde6945ac7c0708a177caf225b5b7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fingerprint.com#website\",\"name\":\"Fingerprint Docs\",\"url\":\"https://docs.fingerprint.com\",\"publisher\":{\"@id\":\"https://docs.fingerprint.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence#webpage\",\"url\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence\",\"name\":\"Collect Intelligence\",\"description\":\"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application. This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team. The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection. Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context. The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend. Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry. ### Event Retrieval Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response. Fetch all Automation Intelligence API events via the /v4/events?source=edge API.\",\"dateModified\":\"2026-08-22T02:25:53.995Z\",\"isPartOf\":{\"@id\":\"https://docs.fingerprint.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Automation Intelligence API\",\"item\":\"https://docs.fingerprint.com/reference/automation-intelligence-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Collect Intelligence\",\"item\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence#apireference\",\"headline\":\"Collect Intelligence\",\"name\":\"Collect Intelligence\",\"description\":\"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application. This feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please contact our support team. The API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection. Automation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context. The API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend. Because this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via visitor_id and a few Smart Signals derived from deep device telemetry. ### Event Retrieval Events created by the Automation Intelligence API can be fetched via the /v4/events/{event_id} API using the event_id present in the API response. Fetch all Automation Intelligence API events via the /v4/events?source=edge API.\",\"url\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fingerprint.com/reference/automation-intelligence-api-collect-intelligence#webpage\"},\"dateModified\":\"2026-08-22T02:25:53.995Z\",\"publisher\":{\"@id\":\"https://docs.fingerprint.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fingerprint.com#website\"}}]}\u003c/script>","agentPointerHref":"/reference/automation-intelligence-api-collect-intelligence.md","siteName":"Fingerprint Docs","nav":{"global":null,"versions":[{"version":"v4","default":true,"tabs":[{"tab":"Home","icon":"house","href":"/"},{"tab":"Start","icon":"play","groups":[{"group":"Getting started","pages":[{"title":"Quick Start Guide","description":"How to quickly add Fingerprint device intelligence to your website or mobile app.","icon":"milestone","href":"/docs/quick-start-guide"},{"title":"Playground","url":"https://demo.fingerprint.com/playground","icon":"mouse-pointer-click","description":null,"href":"/docs/playground"},{"title":"Use Case Tutorials","description":"Step-by-step tutorials for implementing Fingerprint in common fraud prevention scenarios","icon":"book-open","href":"/docs/use-case-tutorials-overview"}]},{"group":"Web","public":true,"icon":"monitor","pages":[{"title":"JavaScript Quickstart","sidebarTitle":"JavaScript","icon":"js","description":"Get started using the JavaScript agent","href":"/docs/javascript-quickstart"},{"title":"React Quickstart","sidebarTitle":"React","icon":"react","description":"Get started using the Fingerprint React SDK","href":"/docs/react-quickstart"},{"title":"Next.js Quickstart","sidebarTitle":"Next.js","description":"Get started using the Fingerprint React SDK with Next.js","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/nextjs.svg","href":"/docs/nextjs-quickstart"},{"title":"Preact Quickstart","sidebarTitle":"Preact","description":"Get started using the Fingerprint React SDK with Preact","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/preact.svg","href":"/docs/preact-quickstart"},{"title":"Vue Quickstart","sidebarTitle":"Vue","icon":"vuejs","description":"Get started using the Fingerprint Vue SDK","href":"/docs/vue-quickstart"},{"title":"Nuxt Quickstart","sidebarTitle":"Nuxt","description":"Get started using the Fingerprint Vue SDK with Nuxt","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/nuxt.svg","href":"/docs/nuxt-quickstart"},{"title":"Angular Quickstart","sidebarTitle":"Angular","icon":"angular","description":"Get started using the Angular SDK","href":"/docs/angular-quickstart"},{"title":"Svelte Quickstart","sidebarTitle":"Svelte","description":"Get started using the Fingerprint Svelte SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/svelte.svg","href":"/docs/svelte-quickstart"}]},{"group":"Mobile","public":true,"icon":"smartphone","pages":[{"title":"Android Quickstart","sidebarTitle":"Android","icon":"android","description":"Get started using the Android SDK","href":"/docs/android-quickstart"},{"title":"iOS Quickstart","sidebarTitle":"iOS","icon":"apple","description":"Get started using the iOS SDK","href":"/docs/ios-quickstart"},{"title":"React Native Quickstart","sidebarTitle":"React Native","icon":"react","description":"Get started using the React Native SDK","href":"/docs/react-native-quickstart"},{"title":"Flutter Quickstart","sidebarTitle":"Flutter","icon":"flutter","description":"Get started using the Flutter SDK","href":"/docs/flutter-quickstart"}]},{"group":"Server","public":true,"icon":"hard-drive","pages":[{"title":"Node.js Server Quickstart","sidebarTitle":"Node.js","icon":"node","description":"Get started using the Node.js Server SDK","href":"/docs/node-server-quickstart"},{"title":"PHP Server Quickstart","sidebarTitle":"PHP","icon":"php","description":"Get started using the PHP Server SDK","href":"/docs/php-server-quickstart"},{"title":"C#/.NET Server Quickstart","sidebarTitle":"C#/.NET","description":"Get started using the C#/.NET Server SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/dotnet.svg","href":"/docs/dotnet-server-quickstart"},{"title":"Go Server Quickstart","sidebarTitle":"Go","icon":"golang","description":"Get started using the Go Server SDK","href":"/docs/go-server-quickstart"},{"title":"Java Server Quickstart","sidebarTitle":"Java","description":"Get started using the Java Server SDK","icon":"java","href":"/docs/java-server-quickstart"},{"title":"Python Server Quickstart","sidebarTitle":"Python","icon":"python","description":"Get started using the Python Server SDK","href":"/docs/python-server-quickstart"}]},{"group":"Use Case Tutorials","icon":"book-open","pages":[{"title":"Account Sharing","description":"Learn how to detect and prevent unauthorized account sharing","href":"/docs/account-sharing-use-case-tutorial"},{"title":"Account Takeover","description":"Learn how to protect your application from account takeover attacks","href":"/docs/account-takeover-use-case-tutorial"},{"title":"Ban Enforcement","description":"Learn how to enforce user bans and prevent banned users from accessing your platform","href":"/docs/ban-enforcement-use-case-tutorial"},{"title":"Bonus Abuse","description":"Learn how to prevent bonus abuse and limit welcome offers to one per device","href":"/docs/bonus-abuse-use-case-tutorial"},{"title":"Card Testing","description":"Learn how to detect and prevent credit card testing fraud","href":"/docs/card-testing-use-case-tutorial"},{"title":"Chargeback Dispute","description":"Learn how to reduce chargebacks and win disputes with device identification data","href":"/docs/chargeback-dispute-use-case-tutorial"},{"title":"Coupon Abuse","description":"Learn how to prevent coupon abuse and protect your promotions from fraud","href":"/docs/coupon-abuse-use-case-tutorial"},{"title":"Credential Stuffing","description":"Learn how to protect your application from credential stuffing attacks","href":"/docs/credential-stuffing-use-case-tutorial"},{"title":"Loan Fraud","description":"Learn how to detect and prevent fraudulent loan applications","href":"/docs/loan-fraud-use-case-tutorial"},{"title":"New Account Fraud","description":"Learn how to detect and prevent fraudulent account creation","href":"/docs/new-account-fraud-use-case-tutorial"},{"title":"Paywall Enforcement","description":"Learn how to implement paywall protection and prevent content bypass","href":"/docs/paywall-use-case-tutorial"},{"title":"Personalization","description":"Learn how to personalize experiences for anonymous visitors","href":"/docs/personalization-use-case-tutorial"},{"title":"Regional Pricing Enforcement","description":"Learn how to implement and enforce regional pricing","href":"/docs/regional-pricing-use-case-tutorial"},{"title":"SMS Pumping","description":"Learn how to detect and prevent SMS pumping fraud","href":"/docs/sms-pumping-use-case-tutorial"},{"title":"Survey Fraud","description":"Learn how to prevent survey fraud and ensure data quality","href":"/docs/survey-fraud-use-case-tutorial"},{"title":"Web Scraping","description":"Learn how to detect and prevent unauthorized web scraping","href":"/docs/web-scraping-use-case-tutorial"}]}]},{"tab":"AI","icon":"cpu","groups":[{"group":"AI tools","pages":[{"title":"Use Fingerprint with AI","sidebarTitle":"Overview","description":"Use AI coding agents and assistants to integrate Fingerprint, manage your workspace, and analyze identification data.","href":"/ai/overview"},{"title":"Fingerprint skills","sidebarTitle":"Skills","description":"Install Fingerprint skills to give your AI coding agent specialized knowledge about Fingerprint.","href":"/ai/skills"},{"title":"Fingerprint CLI","sidebarTitle":"CLI","description":"Integrate Fingerprint into your app and manage API keys and custom subdomains from your terminal.","href":"/ai/cli"},{"title":"Fingerprint MCP server","sidebarTitle":"MCP server","description":"Connect AI assistants and agents to Fingerprint device intelligence","href":"/ai/mcp-server"}]}]},{"tab":"Guides","icon":"book-open","groups":[{"group":"Understanding Fingerprint","icon":"info","pages":[{"title":"Introduction","description":"Learn how you can prevent fraud and improve user experiences with Fingerprint.","href":"/docs/introduction"},{"title":"Planning your implementation","description":"Key considerations to think through before implementing Fingerprint","href":"/docs/planning-implementation"},{"title":"Identification, accuracy, and confidence score","description":"Learn about the different methods Fingerprint uses to identify visitors, how Fingerprint defines and maintains accuracy, and how to use confidence score in your applications.","href":"/docs/identification-accuracy-and-confidence"},{"title":"Privacy and compliance","description":"Overview of Fingerprint's regulatory compliance and how we ensure secure and responsible visitor identification.","href":"/docs/privacy-and-compliance"},{"title":"Regions and data retention","description":"Learn more about where and how we store the identification data of your visitors.","href":"/docs/regions"},{"title":"Browser and device support","description":"An overview of Fingerprint compatibility across various browsers and devices.","href":"/docs/browser-and-device-support"},{"group":"Billing and account limits explained","pages":[{"title":"Overview","description":"A guide to understanding our API request-based billing and related concepts","href":"/docs/billing"},{"title":"Troubleshooting Unexpected Usage Spikes","description":"If you're seeing a sudden spike in Fingerprint usage, it usually comes down to two main causes: implementation issues or malicious traffic. This guide will help you quickly diagnose and resolve the issue.","href":"/docs/troubleshooting-unexpected-usage-spikes"}]},{"group":"Using the dashboard","pages":[{"title":"Overview","description":"A guide to understanding the web-based interface for managing your Fingerprint account.","href":"/docs/using-the-dashboard"},{"title":null,"description":null,"href":"/docs/analytics"},{"title":"Bots and AI agents","description":"Analyze bot and AI agent traffic in the Fingerprint Dashboard, and investigate individual automation events.","href":"/docs/dashboard-bots-ai-agents"},{"title":"Configuring resources","description":"The Dashboard allows you to manage all the resources and settings that govern how your Fingerprint implementation operates.","href":"/docs/configuration"},{"title":"Monitoring health","description":null,"href":"/docs/health"},{"title":"Workspaces \u0026 environments","description":null,"href":"/docs/workspaces-environments"},{"title":"Roles \u0026 permissions","description":null,"href":"/docs/roles-permissions"},{"title":"User preferences","description":null,"href":"/docs/user-preferences"},{"title":"Audit logs","description":null,"href":"/docs/audit-logs"}]}]},{"group":"Identify browsers","icon":"monitor","pages":[{"group":"Install the JavaScript agent","pages":[{"title":"Overview","description":"Learn how to install and use the JavaScript agent to identify visitors.","href":"/docs/install-the-javascript-agent"},{"title":"Configure Content Security Policy (CSP)","description":null,"href":"/docs/js-agent-csp"},{"title":"Optimize JavaScript agent usage","description":"A collection of techniques to optimize your usage of the JavaScript agent. With a few adjustments, you can reduce latency and decrease the number of API calls required for your use case.","href":"/docs/optimize-javascript-agent"},{"title":"Usage with server-side rendering frameworks","description":"Learn how to use Fingerprint with server-side rendering frameworks.","href":"/docs/usage-with-server-side-rendering-frameworks"}]},{"title":"Identify visitors","description":"Learn best practices for timing identification requests, caching visitor IDs, or using linked IDs to associate your own identifiers with each visitor ID.","href":"/docs/identify-visitors"},{"title":"JavaScript Agent API Reference","url":"/reference/js-agent","description":null,"href":"/docs/javascript-agent"},{"group":"Frontend libraries","pages":[{"title":"Overview","description":"Fingerprint offers SDKs for the most popular client-side frameworks and libraries.","keywords":["angular","chrome-extension","nextjs","preact","react","svelte","vue"],"href":"/docs/frontend-libraries"},{"title":"Angular SDK","description":null,"href":"/docs/angular"},{"title":"Google Chrome Extension","description":null,"href":"/docs/fingerprintjs-pro-and-chrome-extension"},{"title":"Next","description":null,"href":"/docs/fingerprintjs-pro-nextjs"},{"title":"Preact","description":null,"href":"/docs/preact"},{"title":"React","description":null,"href":"/docs/react"},{"title":"Svelte","description":null,"href":"/docs/svelte"},{"title":"Vue","description":null,"href":"/docs/vuejs"},{"title":"Generic JavaScript agent wrapper for SPAs","deprecated":true,"description":null,"href":"/docs/generic-js-agent-wrapper-for-spas"}]}]},{"group":"Identify mobile devices","icon":"smartphone","pages":[{"title":"Fingerprint for mobile devices","description":null,"href":"/docs/mobile-identification"},{"group":"iOS devices","pages":[{"title":"iOS devices","description":"Fingerprint's device intelligence platform for iOS devices.","href":"/docs/ios"},{"title":"Understanding privacy manifest files","description":null,"href":"/docs/mobile-devices-understanding-privacy-manifest-files"}]},{"group":"Android devices","pages":[{"title":"Overview","description":"Fingerprint's device intelligence platform for Android devices.","href":"/docs/native-android-integration"},{"title":"Android API call allowance","description":"Prevent fraud in your Android apps for free with Fingerprint device intelligence.","href":"/docs/android-api-call-allowance"}]},{"group":"Mobile SDKs","pages":[{"title":"Overview","description":null,"href":"/docs/mobile-sdks"},{"title":"iOS SDK","description":"A simple guide to integrate Fingerprint's device intelligence platform in your native iOS apps.","href":"/docs/ios-sdk"},{"title":"Android SDK","description":"A simple guide to integrate Fingerprint's device intelligence platform in your native Android apps.","href":"/docs/android-sdk"},{"group":"React Native","pages":[{"title":"Overview","description":null,"href":"/docs/react-native"},{"title":"Migrating the Fingerprint React Native SDK from v3 to v4","description":"This guide covers all breaking changes introduced in version `4.0.0` of the Fingerprint React Native SDK and outlines the steps required to migrate an existing v3 integration.","href":"/docs/react-native-migrating-from-v3-to-v4"}]},{"group":"Flutter","pages":[{"title":"Flutter SDK","sidebarTitle":"Overview","description":"Integrate Fingerprint device intelligence into your Flutter apps on Android, iOS, and web.","href":"/docs/flutter"},{"title":"Migrating the Fingerprint Flutter SDK from v4 to v5","sidebarTitle":"Migrating from v4 to v5","description":"Breaking changes in version `5.0.0` of the Fingerprint Flutter SDK and the steps to migrate an existing v4 integration.","href":"/docs/flutter-migrating-from-v4-to-v5"}]}]}]},{"group":"AI detection","icon":"cpu","pages":[{"title":"AI agent detection","description":"Detect and verify AI agents visiting your web properties, and distinguish them from malicious bots.","href":"/docs/ai-agents"},{"title":"AI assistant detection","description":"Detect and verify AI assistants visiting your web properties or API endpoints and distinguish them from malicious bots.","href":"/docs/ai-assistants"}]},{"group":"Protect your implementation","icon":"shield","pages":[{"group":"Evading ad blockers with proxy integrations","pages":[{"title":"Overview","description":null,"href":"/docs/protecting-the-javascript-agent-from-adblockers"},{"group":"Custom Subdomain","pages":[{"title":"Custom subdomain setup","description":"Using a custom subdomain is required for correct identification while using Fingerprint.","href":"/docs/custom-subdomain-setup"},{"title":"Migrate a legacy subdomain certificate","description":"Move your custom subdomain to the current SSL certificate setup without changing your subdomain or JavaScript agent configuration.","href":"/docs/legacy-subdomain-certificate-migration"}]},{"group":"Cloudflare Proxy Integration","pages":[{"title":"Overview","description":"Fingerprint JavaScript agent v4.0.0 or later is required.","href":"/docs/cloudflare-integration"},{"title":"Blocking Origins and IPs","description":null,"href":"/docs/cloudflare-integration-blocking-ips-and-origins"}]},{"group":"AWS Cloudfront Proxy Integration V2","pages":[{"title":"Overview","description":null,"href":"/docs/cloudfront-proxy-integration-v2"},{"title":"Install CloudFront Integration using CloudFormation","description":null,"href":"/docs/install-cloudfront-integration-using-cloudformation"},{"title":"Install CloudFront Integration using Terraform","description":null,"href":"/docs/aws-cloudfront-integration-via-terraform"},{"title":"Migrating CloudFront proxy integration to JavaScript Agent V4","description":null,"href":"/docs/cloudfront-integration-migration-to-js-agent-v4"}]},{"group":"Fastly VCL Proxy Integration","pages":[{"title":"Overview","description":null,"href":"/docs/fastly-vcl-proxy-integration"},{"title":"Deploy Fastly VCL Manually","description":null,"href":"/docs/deploy-fastly-vcl-manually"},{"title":"Deploy Fastly VCL using Terraform Module","description":null,"href":"/docs/deploy-fastly-vcl-using-terraform"},{"title":"Migrate from API v3 to API v4","description":null,"href":"/docs/fastly-vcl-v3-to-v4-migration-guide"}]},{"group":"Fastly Compute Proxy Integration","pages":[{"title":"Overview","description":null,"href":"/docs/fastly-compute-proxy-integration"},{"title":"Deploy Fastly Compute Proxy Integration Manually","description":null,"href":"/docs/deploy-fastly-compute-manually"},{"title":"Deploy Fastly Compute Proxy Integration with Terraform","description":null,"href":"/docs/deploy-fastly-compute-using-terraform"},{"title":"Migrate Fastly Compute proxy integration to JavaScript agent v4","description":null,"href":"/docs/fastly-compute-v3-to-v4-migration-guide"}]},{"group":"Akamai Proxy Integration","pages":[{"title":"Overview","description":null,"href":"/docs/akamai-proxy-integration"},{"title":"Deploy Akamai Integration using Terraform","description":null,"href":"/docs/deploy-akamai-proxy-integration-via-terraform"},{"title":"Deploy Akamai Integration using Property Manager API","description":null,"href":"/docs/deploy-akamai-proxy-integration-via-papi"},{"title":"Migrate Akamai integration from API v3 to API v4","description":null,"href":"/docs/akamai-v3-to-v4-migration-guide"},{"title":"Troubleshoot 503 errors in Akamai Proxy Integration","description":"Fix 503 errors between Akamai and Fingerprint endpoints by aligning Origin SSL verification settings in your Akamai property rules.","href":"/docs/troubleshooting-akamai-supernet-error"}]},{"group":"Azure Proxy Integration V2","pages":[{"title":"Overview","canonical":"https://docs.fingerprint.com/docs/azure-proxy-integration","description":null,"href":"/docs/azure-proxy-integration"},{"title":"Migrating Azure Proxy integration from v1 to v2","canonical":"https://docs.fingerprint.com/docs/azure-proxy-integration-migration-from-v1-to-v2","description":null,"href":"/docs/azure-proxy-integration-migration-from-v1-to-v2"}]}]},{"title":"Protecting from client-side tampering and replay attacks","description":"Prevent malicious users from bypassing Fingerprint by integrating it with your server and checking the identification results for freshness and consistency with the associated HTTP requests.","href":"/docs/protecting-from-client-side-tampering"},{"group":"Request filtering","pages":[{"title":"Request filtering","description":"Block unwanted identification requests to prevent malicious actors from misusing your Fingerprint public API keys.","href":"/docs/request-filtering"},{"title":"Request filtering for websites","description":null,"href":"/docs/request-filtering-for-websites"},{"title":"Request filtering for mobile apps","description":null,"href":"/docs/mobile-app-filtering"},{"title":"Search bot request filtering","description":"Allow basic search bots filtering through a single switch in the Request Filtering Dashboard section","href":"/docs/search-bots-filtering"},{"title":"AI bot request filtering","description":"Allow basic AI bots filtering through a single switch in the Request Filtering","href":"/docs/ai-bot-filtering"},{"title":"Network request filtering","description":"Filter unwanted traffic based on a list of source IP addresses","href":"/docs/network-request-filtering"},{"group":"(Beta) Request Filtering V2","pages":[{"title":"(Beta) Request filtering V2","description":"Block unwanted identification requests to prevent malicious actors from misusing your Fingerprint public API keys.","href":"/docs/request-filtering-v2"},{"title":"Expression language reference","description":"Rule expressions are written using a simple expression language. It provides a rich set of operators and builtin functions, and allows you to create flexible conditions and criteria.","href":"/docs/expression-language-reference"}]}]},{"title":"Protecting from payload replay attacks","description":"Identify malicious actors that capture and replay the client-side request payload using the replayed flag.","href":"/docs/protecting-from-payload-replay-attacks"}]},{"group":"Integrate with your server","icon":"hard-drive","pages":[{"title":"Get server side intelligence","description":null,"href":"/docs/get-server-side-intelligence"},{"title":"Server API","url":"/reference/server-api","description":null,"href":"/docs/server-api"},{"title":"Webhooks","description":"Receive an HTTP request to your server with Fingerprint results for every identification event the moment it happens.","href":"/docs/webhooks"},{"title":"Sealed Client Results","description":"Receive an encrypted payload in the JavaScript agent with all information available in the /v4/events endpoint, meant to be decrypted and used on your backend.","href":"/docs/sealed-client-results"},{"title":"Backend libraries","url":"/reference/server-sdks","description":null,"href":"/docs/server-sdks"},{"title":"Zero Trust Mode","description":null,"href":"/docs/zero-trust-mode"},{"title":"Management API","url":"/reference/management-api","description":null,"href":"/docs/management-api"},{"group":"Data integrations","pages":[{"title":"Google Tag Manager","description":null,"href":"/docs/fingerprintjs-pro-google-tag-manager"},{"title":"Matomo / Piwik","description":"Learn how to use Matomo (formerly Piwik) with Fingerprint to identify visitors.","href":"/docs/matomo-piwik"},{"title":"Segment Data Integration","description":null,"href":"/docs/segment"}]}]},{"group":"Integrate Smart Signals","icon":"zap","pages":[{"title":"Smart Signals introduction","description":"Smart Signals give you actionable device intelligence for browsers and devices","href":"/docs/smart-signals-introduction"},{"title":"Smart Signals reference","description":"Fingerprint is not just an identity platform; it also helps fight fraud by providing actionable device intelligence called Smart Signals. This page contains the reference information for individual Smart Signal components and their applications.","href":"/docs/smart-signals-reference"},{"title":"Suspect Score","description":"Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow. It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity.","href":"/docs/suspect-score"},{"title":"AI agent detection","description":"Detect and verify AI agents visiting your web properties, and distinguish them from malicious bots.","href":"/docs/ai-agents"},{"title":"AI assistant detection","description":"Detect and verify AI assistants visiting your web properties or API endpoints and distinguish them from malicious bots.","href":"/docs/ai-assistants"},{"group":"Bot Detection","public":true,"pages":[{"title":"Bot Detection Overview","description":"Overview of Fingerprint bot detection for AI automation, browsers and tools","href":"/docs/bot-detection/overview"},{"title":"Bot Directory","url":"https://fingerprint.com/bot-directory/","description":"This directory lists bots Fingerprint can detect. This is not an exhaustive list, more bots are coming soon.","href":"/docs/bot-detection/bot-directory"},{"title":"Web Bot Auth Implementation","description":"Web Bot Auth is used as a verification method for verified bots and signed agents.","href":"/docs/bot-detection/web-bot-auth-implementation"}]}]},{"group":"Fraud Score","icon":"gauge","pages":[{"title":"Fraud Score Overview","description":null,"href":"/docs/fraud-score-overview"},{"title":"Understanding Fraud Score","sidebarTitle":"Understanding Fraud Score","description":null,"href":"/docs/fraud-score"},{"title":"Labeling events for Fraud Score","sidebarTitle":"Labeling events","description":"Create and manage Fraud Score labels, and label events by CSV upload, in the Dashboard, or with the Server API.","href":"/docs/fraud-score-labeling"},{"title":"Monitoring your Fraud Score dataset","sidebarTitle":"Monitoring your dataset","description":"Check the labeled events your Fraud Score models train on, follow your uploads, and fix rejected rows.","href":"/docs/fraud-score-dataset"},{"title":"Managing Fraud Score models","sidebarTitle":"Managing models","description":"Review Fraud Score model performance, choose a threshold, and approve new model versions in the Dashboard.","href":"/docs/fraud-score-models"}]},{"group":"Rules Engine and Flow (Beta)","icon":"network","pages":[{"title":"Rules Engine (Beta)","description":"Protect your application with rules based on Fingerprint device intelligence. Define fraud detection rules in Fingerprint and evaluate them against identification events.","href":"/docs/rules-engine"},{"title":"Flow deployments on Cloudflare (Beta)","description":"Deploy Fingerprint identification and protection to the edge with little to no changes to your application code.","href":"/docs/flow-deployments"}]},{"group":"Tips and advanced guides","icon":"lightbulb","pages":[{"title":"Linking and tagging information","description":null,"href":"/docs/tagging-information"},{"title":"Multiple environments","description":null,"href":"/docs/multiple-environments"},{"title":"Supplementary Identifiers: High Recall ID","description":"Learn how High Recall ID improves visitor recognition for personalization and reduces friction for legitimate users","href":"/docs/supplementary-identifiers-highrecall"},{"title":"Identification using pseudonymized IP Address","description":null,"href":"/docs/identification-using-pseudonymized-ip-address"},{"title":"Identifying in-app browsers for iOS","description":null,"href":"/docs/identifying-in-app-browsers-for-ios"},{"title":"Identifying users in hybrid app frameworks","description":null,"href":"/docs/identifying-users-in-hybrid-app-frameworks"},{"title":"Visitor footprint timestamps","description":"Visitor footprint timestamps represent two significant events for a browser or device:","href":"/docs/useful-timestamps"}]},{"group":"Platform updates","icon":"history","pages":[{"title":"Changelog (JavaScript agent)","url":"/docs/changelog-javascript-agent","description":null,"href":"/docs/changelog"},{"title":"Android SDK Changelog","url":"/docs/changelog-android-sdk","description":null,"href":"/docs/android-sdk-changelog"},{"title":"iOS SDK Changelog","url":"/docs/changelog-ios-sdk","description":null,"href":"/docs/ios-sdk-changelog"}]},{"group":"Resources","icon":"circle-question-mark","pages":[{"title":"Discord Server","url":"https://discord.gg/ad6R2ttHVX","description":null,"href":"/docs/discord"},{"title":"Status Page","url":"https://status.fingerprint.com/","description":null,"href":"/docs/status"},{"title":"Product Roadmap","url":"https://roadmap.fingerprint.com/","description":null,"href":"/docs/product-roadmap"},{"title":"Glossary","description":null,"href":"/docs/glossary"},{"title":"Migrating from FingerprintJS to Fingerprint","description":null,"href":"/docs/migrating-from-fingerprintjs-to-fingerprint-pro"}]},{"group":"Legal","icon":"gavel","pages":[{"title":"Terms of service","description":"Effective date: Nov 1, 2026. | [Archived Versions](/docs/legal-archive)","href":"/docs/terms-of-service"},{"title":"Privacy policy","description":"Effective date: November 1, 2026. | [Archived Versions](/docs/legal-archive)","href":"/docs/privacy-policy"},{"title":"DPA (GDPR)","description":null,"href":"/docs/dpa-gdpr"},{"title":"DPA (US SPL)","description":"US State Privacy Laws Data Processing Addendum","href":"/docs/dpa-usspl"},{"title":"DORA","description":null,"href":"/docs/dora"}]}]},{"tab":"API Reference","icon":"code","groups":[{"group":"JavaScript Agent","pages":[{"title":"Overview","description":"The Fingerprint JavaScript agent is a high-performance JavaScript function that collects multiple device and browser signals and sends them to the Fingerprint API for visitor identification and device intelligence analysis.","href":"/reference/js-agent"},{"title":"start function","description":"API reference for the JavaScript agent's `start()` function","href":"/reference/js-agent-start-function"},{"title":"get function","description":"This page contains the API reference for the JavaScript agent `get()` function or its equivalent in your frontend library. The function is not exported directly from the [@fingerprint/agent](https://www.npmjs.com/package/@fingerprint/agent) NPM package. Instead, it is a method on the agent instance returned by the [start()](/reference/js-agent-start-function) function.","href":"/reference/js-agent-get-function"},{"title":"Error handling","description":"Error handling overview and best practices for JavaScript agent","href":"/reference/js-agent-error-handling"}]},{"group":"Server API","pages":[{"title":"Server API","description":"Fingerprint Server API enables you to get more information about your visitors or about individual identification events.","href":"/reference/server-api"},{"group":"Events","expanded":true,"pages":[{"openapi":"get /events/{event_id}","title":"Get an event by event ID","description":"Get a detailed analysis of an individual identification event, including Smart Signals.\n\nUse `event_id` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `event_id`.\n","href":"/reference/server-api-get-event"},{"openapi":"patch /events/{event_id}","title":"Update an event","description":"Change information in existing events specified by `event_id` or *flag suspicious events*.\n\nWhen an event is created, it can be assigned `linked_id` and `tags` submitted through the JavaScript agent parameters.\nThis information might not have been available on the client initially, so the Server API permits updating these attributes after the fact.\n\n**Warning** You can only update events created within the last 10 days. Updating an older event returns HTTP 400 with the message `event is too old to be updated (> 10 days)`, even if your plan retains events for longer.\n\n**Warning** Events created by the Automation Intelligence API (`POST /edge`) cannot be updated. Updating them returns HTTP 400.\n\n**Warning** Trying to update an event immediately after creation may temporarily result in an \nerror (HTTP 409 Conflict. The event is not mutable yet.) as the event is fully propagated across our systems. In such a case, simply retry the request.\n","href":"/reference/server-api-update-event"},{"openapi":"get /events","title":"Search events","description":"## Search\n\nThe `/v4/events` endpoint provides a convenient way to search for past events based on specific parameters. Typical use cases and queries include:\n\n- Searching for events associated with a single `visitor_id` within a time range to get historical behavior of a visitor.\n- Searching for events associated with a single `linked_id` within a time range to get all events associated with your internal account identifier.\n- Excluding all bot traffic from the query (`good` and `bad` bots)\n\nBy default, the API searches events from the last 7 days, sorts them by newest first and returns the last 10 events.\n\n- Use `start` and `end` to specify the time range of the search.\n- Use `reverse=true` to sort the results oldest first.\n- Use `limit` to specify the number of events to return.\n- Use `pagination_key` to get the next page of results if there are more than `limit` events.\n\n### Filtering events with the `suspect` flag\n\nThe `/v4/events` endpoint unlocks a powerful method for fraud protection analytics. The `suspect` flag is exposed in all events where it was previously set by the update API.\n\nYou can also apply the `suspect` query parameter as a filter to find all potentially fraudulent activity that you previously marked as `suspect`. This helps identify patterns of fraudulent behavior.\n\n### Environment scoping\n\nIf you use a secret key that is scoped to an environment, you will only get events associated with the same environment. With a workspace-scoped environment, you will get events from all environments.\n\nSmart Signals not activated for your workspace or are not included in the response.\n","href":"/reference/server-api-search-events"},{"openapi":"post /events/{event_id}/feedback","title":"Submit feedback for an event","description":"Use this API to submit feedback for a specific, existing event, identified by `event_id`.\n\nFeedback is queued and processed asynchronously. Subsequent Server API responses may not reflect the feedback immediately.\n\nDuplicate feedback requests for the same event are allowed; however, the most recent feedback overrides all previous submissions for that event.\n\n### Availability\nThis API is currently in beta and available only for Enterprise plans. If you are interested, please [contact our support team](https://fingerprint.com/support/).\n\n### Rate limits and daily quota\nThe rate limits and daily quota for this API **differ** from those for our other APIs.\n\nFeedback can be submitted at a maximum of 30 requests per hour (RPH) and cannot exceed 500 requests per day (RPD).\n\nYou can request an increase to these limits by contacting [our support team](https://fingerprint.com/support/). \n","href":"/reference/server-api-submit-event-feedback"}]},{"group":"Visitors","expanded":true,"pages":[{"openapi":"reference/server-api.yaml DELETE /visitors/{visitor_id}","title":"Delete a visitor ID","description":"Use this API to request the deletion of all data associated with a specific visitor ID.\n\nUpon a request to delete data for a visitor ID,\n- The data collected from the corresponding browser (or device) will be deleted asynchronously, typically within a few minutes. This data will no longer be available to identify this browser (or device). When the same browser (or device) revisits, it will receive a new visitor ID.\n- The identification events made from this browser (or device) in the past 10 days are typically deleted within 24 hrs. \n- The identification events made from this browser (or device) outside of the 10 days will be purged as per your [data retention period](https://docs.fingerprint.com/docs/regions#data-retention).\n\nThe following timeline illustrates which events are deleted and which remain after a DELETE API request:\n```\nDay 1: First visit from browser A. (Assigned visitor ID: VID1000)\nDay 2: Browser A revisits. (Assigned the same visitor ID: VID1000)\nDay 13: Browser A revisits. (Assigned the same visitor ID: VID1000)\nDay 14: Delete VID1000\nDay 15: Browser A re-visits. (Assigned a different visitor ID: VID9999)\nDay 15: GET /events/day-13 (Returns 404. The event is within the 10 days of deleting VID1000 and will have been deleted)\nDay 16: GET /events/day-2 (Returns 200. The event is outside of the 10 days of deleting VID1000 and is still available)\n```\n\n### Availability\nThis API is available only for Enterprise plans **upon request**. If you are interested, please [contact our support team](https://fingerprint.com/support/).\n\n### Rate limits and daily quota\nThe rate limits and daily quota for this API **differ** from those for our other API.\n\nThe maximum number of DELETE requests that can be made in an hour cannot exceed 30 RPH, and the maximum number that can be made in a day cannot exceed 500 RPD.\n\nYou can request an increase to these limits by contacting [our support team](https://fingerprint.com/support/). \n","href":"/reference/server-api-delete-visitor-id"}]},{"group":"Fraud Score","expanded":true,"pages":[{"openapi":"post /labels","title":"Submit Fraud Labels for an event","description":"Submits labels for a single event, no more than 30 days old. The submission is processed synchronously — a `200`\nresponse means the labels were stored (`status: applied`), or that the event already had them (`status:\nunchanged`). A `422` with `status: rejected` means the labels were not stored; see `errors`.\n","href":"/reference/server-api-submit-fraud-labels"}]},{"title":"Webhook","openapi":"webhook event","description":null,"href":"/reference/posteventwebhook"}]},{"group":"Automation Intelligence API","pages":[{"title":"Automation Intelligence API","description":"The Automation Intelligence API (in public preview) gives you the tools to determine whether traffic is legitimate and should be accepted by your application.","href":"/reference/automation-intelligence-api"},{"openapi":"post /edge","title":"Collect Intelligence","description":"The Automation Intelligence API gives you the tools to determine whether traffic is legitimate and should be accepted by your application.\n\nThis feature is currently in a Public Preview testing phase. All feedback is welcome! If you encounter any issues, please [contact our support team](https://fingerprint.com/support/).\n\nThe API detects automation tools like AI Agents, AI Assistants, AI Browsers, and other bots. Additionally, it provides IP intelligence like geolocation, residential proxy, VPN and data center detection.\n\nAutomation Intelligence is derived from HTTP request metadata that reaches your server. It does not require the use of a JavaScript client-side agent or mobile SDKs to collect device context.\n\nThe API is fast, with average response times of less than 30ms, making it a great fit for edge, pre-origin or middleware contexts. The API is platform-agnostic and can be used with different CDN providers, cloud platforms, or any server backend.\n\nBecause this API doesn’t require the use of a client-side device collection agent, it doesn’t support device identification via `visitor_id` and a few Smart Signals derived from deep device telemetry.\n\n### Event Retrieval\n\nEvents created by the Automation Intelligence API can be fetched via the [`/v4/events/{event_id}`](https://docs.fingerprint.com/reference/server-api-get-event) API using the `event_id` present in the API response.\n\nFetch all Automation Intelligence API events via the [`/v4/events?source=edge`](https://docs.fingerprint.com/reference/server-api-search-events#parameter-source) API.\n","href":"/reference/automation-intelligence-api-collect-intelligence"},{"title":"Flow worker request headers","description":null,"href":"/reference/flow-worker-headers"}]},{"group":"Policy and Upgrades","pages":[{"title":"API Deprecation Policy","description":"At Fingerprint, we regularly release updates to our JavaScript agent, APIs, and SDKs, to give you more features, increased security, and better performance. Sometimes, this means older versions of our APIs will no longer be supported.","href":"/reference/api-deprecation-policy"},{"title":"Migrating JavaScript agent from v3 to v4","description":"Comprehensive migration guide with all migration requirements between the v3 (3.x.x) and v4 (4.x.x) JavaScript agent versions.","href":"/reference/migrating-from-v3-to-v4"},{"title":"Migrating the Fingerprint Android SDK from v2 to v4","description":"This guide covers all breaking changes introduced in version `4.0.0` of the Fingerprint Android SDK and outlines the steps required to migrate an existing v2 integration.","href":"/reference/migrating-android-sdk-from-v2-to-v4"},{"title":"Migrating the Fingerprint iOS SDK from v2 to v4","description":"This guide covers all breaking changes introduced in version `4.0.0` of the Fingerprint iOS SDK and outlines the steps required to migrate an existing v2 integration.","href":"/reference/migrating-ios-sdk-from-v2-to-v4"},{"title":"Migrating from Server API v3 to v4","description":"Learn how to migrate your integration from the deprecated Server API v3 endpoints to the new, improved Server API v4. This guide covers endpoint changes, authentication updates, and best practices for a smooth transition.","href":"/reference/migrating-from-server-api-v3-to-v4"}]},{"group":"Management API","pages":[{"title":"Overview","description":"Management API allows you to manage your Fingerprint account and workspaces programmatically from a server environment.","href":"/reference/management-api"},{"title":"Authentication","description":"Management API requests are authorized by using the **Management API key**.","href":"/reference/management-api-authentication"},{"title":"Versioning","description":"Management API is *versioned*. When backwards-incompatible changes are made to the API, we release a new, dated version.","href":"/reference/management-api-versioning"},{"title":"Pagination","description":null,"href":"/reference/management-api-pagination"},{"title":"Changelog","description":"This changelog lists all additions and updates to the Management API, in chronological order.","href":"/reference/management-api-changelog"},{"group":"API Reference (2025-11-20)","expanded":true,"pages":[{"group":"api-keys","expanded":true,"pages":[{"title":"Create API key","openapi":"reference/management-api_2025-11-20.json POST /api-keys","description":"Creates an API key for the workspace associated with the Management API key. Maximum number of API keys in defined by your plan limits. If you need additional API keys, contact our support team.","href":"/reference/apikeyscontroller_create"},{"title":"List API keys","openapi":"reference/management-api_2025-11-20.json GET /api-keys","description":"Lists all API keys for the workspace associated with the Management API key.","href":"/reference/apikeyscontroller_findall"},{"title":"Get API key","openapi":"reference/management-api_2025-11-20.json GET /api-keys/{id}","description":"Fetch an API key by ID.","href":"/reference/apikeyscontroller_findone"},{"title":"Update API key","openapi":"reference/management-api_2025-11-20.json PATCH /api-keys/{id}","description":"Updates a single API key. You can update the keys name, description, status, and rate limit. You cannot mutate the actual key itself.","href":"/reference/apikeyscontroller_update"},{"title":"Delete API key","openapi":"reference/management-api_2025-11-20.json DELETE /api-keys/{id}","description":"Deletes an API key with the given ID. Make sure that the key you are deleting is not used in production environment. This action is not reversible.","href":"/reference/apikeyscontroller_deleteapikey"}]},{"group":"environments","expanded":true,"pages":[{"title":"Create an environment","openapi":"reference/management-api_2025-11-20.json POST /environments","description":"Creates a new environment for the workspace associated with the Management API key. Maximum number of environments in defined by your plan limits. If you need additional environments, contact our support team.","href":"/reference/environmentcontroller_create"},{"title":"List environments","openapi":"reference/management-api_2025-11-20.json GET /environments","description":"Lists all environments for the workspace associated with the Management API key.","href":"/reference/environmentcontroller_findallv2"},{"title":"Update an environment","openapi":"reference/management-api_2025-11-20.json POST /environments/{id}","description":"Updates an environment with the given environment ID. You can update the name, description, and limit settings.","href":"/reference/environmentcontroller_update"},{"title":"Delete an environment","openapi":"reference/management-api_2025-11-20.json DELETE /environments/{id}","description":"Deletes an environment with the given environment ID. You can only delete environments that don't have any active API keys associated with it.","href":"/reference/environmentcontroller_delete"}]},{"group":"filtering-rules","expanded":true,"pages":[{"title":"Create a filtering rule","openapi":"reference/management-api_2025-11-20.json POST /filtering-rules","description":"Creates a new filtering rule. The rule will be evaluated in order based on the placement parameter. If no placement is specified, the rule is added to the end.","href":"/reference/filteringrulesv2controller_create"},{"title":"List filtering rules","openapi":"reference/management-api_2025-11-20.json GET /filtering-rules","description":"Lists all filtering rules for the workspace associated with the Management API key. Supports filtering by environment, status, and name.","href":"/reference/filteringrulesv2controller_findall"},{"title":"Retrieve filtering rule","openapi":"reference/management-api_2025-11-20.json GET /filtering-rules/{id}","description":"Retrieves a single filtering rule by ID.","href":"/reference/filteringrulesv2controller_findone"},{"title":"Update filtering rule","openapi":"reference/management-api_2025-11-20.json POST /filtering-rules/{id}","description":"Updates an existing filtering rule. Only provided fields will be updated.","href":"/reference/filteringrulesv2controller_update"},{"title":"Bulk create/update filtering rules","openapi":"reference/management-api_2025-11-20.json POST /filtering-rules/bulk","description":"Creates or updates multiple filtering rules at once. In \"merge\" mode (default), rules with IDs are updated and rules without IDs are created. In \"overwrite\" mode, all existing rules for the given environment are deleted and replaced with the provided rules.","href":"/reference/filteringrulesv2controller_bulk"},{"title":"Test filtering rules","openapi":"reference/management-api_2025-11-20.json POST /filtering-rules/test","description":"Tests filtering rules against a specified request ID or custom event payload. You can provide an existing request ID (up to 3 months old) or a custom JSON payload. Optionally, you can provide custom rules to test instead of using existing rules.","href":"/reference/filteringrulesv2controller_test"},{"title":"Delete filtering rule","openapi":"reference/management-api_2025-11-20.json DELETE /filtering-rules/{id}","description":"Deletes a filtering rule with the given ID. Make sure the rule is not critical for your production environment. This action is not reversible.","href":"/reference/filteringrulesv2controller_delete"}]},{"group":"webhooks","expanded":true,"pages":[{"title":"Create a webhook","openapi":"reference/management-api_2025-11-20.json POST /webhooks","description":"Creates a new webhook in the workspace associated with the Management API key.\nWebhook needs to be verified before it will start sending identification events to your server. See webhook verification.\nIf webhook signatures are enabled (enterprise only), signing key will be visible in the response after creation. When fetching webhooks after creation, signing key will not be visible!\nSee webhooks documentation for more details.\nWhen specifying an environment during creation, webhook should be assigned to the given environment. Setting environment to null creates a global webhook.","href":"/reference/webhookscontroller_create"},{"title":"List webhooks","openapi":"reference/management-api_2025-11-20.json GET /webhooks","description":"Lists all webhooks associated to the Management API key, optionally filtered by status.","href":"/reference/webhookscontroller_findallv2"},{"title":"Get webhook by ID","openapi":"reference/management-api_2025-11-20.json GET /webhooks/{id}","description":"Fetch a specific webhook by ID.","href":"/reference/webhookscontroller_findone"},{"title":"Update webhook","openapi":"reference/management-api_2025-11-20.json PATCH /webhooks/{id}","description":"Updates the webhook with the given ID. You can update the name, description, status, URL, and set basic authentication.\nChanging the URL will require this webhook to be verified again.\nChanging the status will disable/enable sending of identification events to your webhook.","href":"/reference/webhookscontroller_update"},{"title":"Verify webhook","openapi":"reference/management-api_2025-11-20.json POST /webhooks/{id}/verification","description":"Send a mocked test event in order to verify your webhook endpoint, it needs to respond with HTTP 200 to be verified.\nWebhook needs to be verified before it will receive identification events.","href":"/reference/webhookscontroller_verify"},{"title":"Delete webhook","openapi":"reference/management-api_2025-11-20.json DELETE /webhooks/{id}","description":"Deletes the webhook with the given ID. This action is not reversible. Changes will take affect in a few minutes.","href":"/reference/webhookscontroller_remove"}]},{"group":"encryption keys","expanded":true,"pages":[{"title":"List encryption keys","openapi":"reference/management-api_2025-11-20.json GET /encryption-keys","description":"Lists all encryption keys for the workspace associated with the Management API key.","href":"/reference/encryptionkeyscontroller_findall"},{"title":"Get encryption key","openapi":"reference/management-api_2025-11-20.json GET /encryption-keys/{id}","description":"Fetch an encryption key by ID.","href":"/reference/encryptionkeyscontroller_findone"},{"title":"Update encryption key","openapi":"reference/management-api_2025-11-20.json PATCH /encryption-keys/{id}","description":"Updates a single encryption key. You can update the keys name, description, and status. You cannot mutate the actual key itself.","href":"/reference/encryptionkeyscontroller_update"},{"title":"Rotate encryption key","openapi":"reference/management-api_2025-11-20.json POST /encryption-keys/{id}/rotate","description":null,"href":"/reference/encryptionkeyscontroller_rotate"},{"title":"Revert encryption key rotation","openapi":"reference/management-api_2025-11-20.json POST /encryption-keys/{id}/revert","description":"Reverts the last encryption key rotation.","href":"/reference/encryptionkeyscontroller_revert"}]},{"group":"subdomains","expanded":true,"pages":[{"title":"Register a subdomain","openapi":"reference/management-api_2025-11-20.json POST /subdomains","description":"Register a new custom subdomain and receive its DNS records. Optionally pass `webhook_url` to get a signed POST callback on every status change instead of polling; the signing secret is returned once in this response as `webhook_secret`.","href":"/reference/subdomainscontroller_create"},{"title":"List subdomains","openapi":"reference/management-api_2025-11-20.json GET /subdomains","description":"Lists all custom subdomains for the workspace associated with the Management API key.","href":"/reference/subdomainscontroller_findall"},{"title":"Get subdomain","openapi":"reference/management-api_2025-11-20.json GET /subdomains/{id}","description":"Fetch a subdomain by ID.","href":"/reference/subdomainscontroller_findone"},{"title":"Create Domain Connect URL","openapi":"reference/management-api_2025-11-20.json POST /subdomains/{id}/domain-connect","description":"Create a signed Domain Connect URL for the subdomain. With `port`, the URL redirects to a Fingerprint CLI loopback callback at `http://127.0.0.1:{port}/domain-connect/callback`, so the client must listen on that port before opening it; the URL is specific to that session and is not stored on the subdomain. Without `port`, the URL redirects to the subdomain page in the Fingerprint dashboard, which confirms the result. Open it in the user’s browser, then use the verify endpoint to check DNS and certificate progress.","href":"/reference/subdomainscontroller_createdomainconnecturl"},{"title":"Verify subdomain","openapi":"reference/management-api_2025-11-20.json POST /subdomains/{id}/verify","description":"Trigger manual verification for a subdomain.","href":"/reference/subdomainscontroller_verify"},{"title":"Delete subdomain","openapi":"reference/management-api_2025-11-20.json DELETE /subdomains/{id}","description":"Delete a subdomain by ID.","href":"/reference/subdomainscontroller_delete"}]}]},{"group":"API Reference (2024-05-20)","expanded":false,"pages":[{"group":"api-keys","expanded":true,"pages":[{"title":"List API keys","openapi":"reference/management-api_2024-05-20.json GET /api-keys","deprecated":true,"description":"Lists all API keys for the workspace associated with the Management API key.","href":"/reference/2024-05-20-apikeyscontroller_findall"},{"title":"Create API key","openapi":"reference/management-api_2024-05-20.json POST /api-keys","deprecated":true,"description":"Creates an API key for the workspace associated with the Management API key. Maximum number of API keys in defined by your plan limits. If you need additional API keys, contact our support team.","href":"/reference/2024-05-20-apikeyscontroller_create"},{"title":"Get API key","openapi":"reference/management-api_2024-05-20.json GET /api-keys/{id}","deprecated":true,"description":"Fetch an API key by ID.","href":"/reference/2024-05-20-apikeyscontroller_findone"},{"title":"Update API key","openapi":"reference/management-api_2024-05-20.json PATCH /api-keys/{id}","deprecated":true,"description":"Updates a single API key. You can update the keys name, description, status, and rate limit. You cannot mutate the actual key itself.","href":"/reference/2024-05-20-apikeyscontroller_update"},{"title":"Delete API key","openapi":"reference/management-api_2024-05-20.json DELETE /api-keys/{id}","deprecated":true,"description":"Deletes an API key with the given ID. Make sure that the key you are deleting is not used in production environment. This action is not reversible.","href":"/reference/2024-05-20-apikeyscontroller_deleteapikey"}]},{"group":"environments","expanded":true,"pages":[{"title":"List environments","openapi":"reference/management-api_2024-05-20.json GET /environments","deprecated":true,"description":"Lists all environments for the workspace associated with the Management API key.","href":"/reference/2024-05-20-environmentcontroller_findall"},{"title":"Create environment","openapi":"reference/management-api_2024-05-20.json POST /environments","deprecated":true,"description":"Creates a new environment for the workspace associated with the Management API key. Maximum number of environments in defined by your plan limits. If you need additional environments, contact our support team.","href":"/reference/2024-05-20-environmentcontroller_create"},{"title":"Update environment","openapi":"reference/management-api_2024-05-20.json POST /environments/{id}","deprecated":true,"description":"Updates an environment with the given environment ID. You can update the name, description, and limit settings.","href":"/reference/2024-05-20-environmentcontroller_update"},{"title":"Delete environment","openapi":"reference/management-api_2024-05-20.json DELETE /environments/{id}","deprecated":true,"description":"Deletes an environment with the given environment ID. You can only delete environments that don't have any active API keys associated with it.","href":"/reference/2024-05-20-environmentcontroller_delete"}]},{"group":"filtering-rules","expanded":true,"pages":[{"title":"List filtering rules","openapi":"reference/management-api_2024-05-20.json GET /filtering-rules","deprecated":true,"description":"Lists all request filtering rules for the workspace associated with the Management API key.","href":"/reference/2024-05-20-filteringrulescontroller_findall"},{"title":"Set filtering rules","openapi":"reference/management-api_2024-05-20.json POST /filtering-rules","deprecated":true,"description":"Creates or updates filtering rules for an environment in bulk. This action will overwrite any existing filtering rules on specified environment. If there is no filtering rules for an environment, this action creates them. To completely remove filtering rules, set both `allow` and `deny` lists to an empty array (`[]`).\nCurrently only supports origin domain filtering.\n\nNote: It can take up to 5 minutes to start filtering incoming requests after setting a rule.","href":"/reference/2024-05-20-filteringrulescontroller_create"},{"title":"Mutate filtering rules","openapi":"reference/management-api_2024-05-20.json PATCH /filtering-rules","deprecated":true,"description":"Allows atomic mutation to filtering rules for an environment. Explicitly specify which list (`allow` or `deny`) you are mutating and which operation (`add` or `remove`) you want to execute with the given list of items.\nCurrently only supports origin domain filtering.\n\n**Note**: It can take up to 5 minutes to start filtering incoming requests after setting a rule.","href":"/reference/2024-05-20-filteringrulescontroller_update"}]},{"group":"webhooks","expanded":true,"pages":[{"title":"List webhooks","openapi":"reference/management-api_2024-05-20.json GET /webhooks","deprecated":true,"description":"Lists all webhooks associated to the Management API key, optionally filtered by status.","href":"/reference/2024-05-20-webhookscontroller_findall"},{"title":"Create webhook","openapi":"reference/management-api_2024-05-20.json POST /webhooks","deprecated":true,"description":"Creates a new webhook in the workspace associated with the Management API key.\nWebhook needs to be verified before it will start sending identification events to your server. See webhook verification.\nIf webhook signatures are enabled (enterprise only), signing key will be visible in the response after creation. When fetching webhooks after creation, signing key will not be visible!\nSee webhooks documentation for more details.\nWhen specifying an environment during creation, webhook should be assigned to the given environment. Setting environment to null creates a global webhook.","href":"/reference/2024-05-20-webhookscontroller_create"},{"title":"Get webhook by ID","openapi":"reference/management-api_2024-05-20.json GET /webhooks/{id}","deprecated":true,"description":"Fetch a specific webhook by ID.","href":"/reference/2024-05-20-webhookscontroller_findone"},{"title":"Update webhook","openapi":"reference/management-api_2024-05-20.json PATCH /webhooks/{id}","deprecated":true,"description":"Updates the webhook with the given ID. You can update the name, description, status, URL, and set basic authentication.\nChanging the URL will require this webhook to be verified again.\nChanging the status will disable/enable sending of identification events to your webhook.","href":"/reference/2024-05-20-webhookscontroller_update"},{"title":"Delete webhook","openapi":"reference/management-api_2024-05-20.json DELETE /webhooks/{id}","deprecated":true,"description":"Deletes the webhook with the given ID. This action is not reversible. Changes will take affect in a few minutes.","href":"/reference/2024-05-20-webhookscontroller_remove"},{"title":"Verify webhook","openapi":"reference/management-api_2024-05-20.json POST /webhooks/{id}/verification","deprecated":true,"description":"Send a test event in order to verify your webhook endpoint, it needs to respond with HTTP 200 to be verified.\nWebhook needs to be verified before it will receive identification events.","href":"/reference/2024-05-20-webhookscontroller_verify"}]}]}]},{"group":"Server SDKs","pages":[{"title":"Server SDKs","description":"Fingerprint offers SDKs for the most popular server-side frameworks and languages. The SDKs make it easier to work with Fingerprint Server API, Webhooks, and other features by providing utility methods and types.","href":"/reference/server-sdks"},{"title":"Go Server SDK","description":"The [Fingerprint Server Go SDK](https://github.com/fingerprintjs/go-sdk) is an easy way to interact with our Server API from your Go application. You can retrieve visitor history or individual identification events. View our [Go Server SDK quickstart](/docs/go-server-quickstart) for a step-by-step guide to get started.","href":"/reference/go-server-sdk"},{"title":"Java Server SDK","description":"The [Fingerprint Server Java SDK](https://github.com/fingerprintjs/java-sdk) is an easy way to interact with our Server API from your Java application. You can retrieve and manage identification events. View our [Java Server SDK quickstart](/docs/java-server-quickstart) for a step-by-step guide to get started.","href":"/reference/java-server-sdk"},{"title":"Node Server SDK","description":"The [Fingerprint Server Node SDK](https://github.com/fingerprintjs/node-sdk) is an easy way to interact with our Server API from your Node application. You can retrieve visitor history or individual identification events. View our [Node Server SDK quickstart](/docs/node-server-quickstart) for a step-by-step guide to get started.","href":"/reference/node-server-sdk"},{"title":"PHP Server SDK","description":"The PHP Server SDK is an easy way to interact with our Server API from your PHP application. You can retrieve visitor history or individual identification events. View our [PHP Server SDK quickstart](/docs/php-server-quickstart) for a step-by-step guide to get started.","href":"/reference/php-server-sdk"},{"title":"Python Server SDK","description":"[Fingerprint Server Python SDK](https://github.com/fingerprintjs/python-sdk) is an easy way to interact with our Server API from your Python application. You can retrieve visitor history or individual identification events. View our [Python Server SDK quickstart](/docs/python-server-quickstart) for a step-by-step guide to get started.","href":"/reference/python-server-sdk"},{"title":".NET Server SDK","description":"The [Fingerprint Server C#/.NET SDK](https://github.com/fingerprintjs/dotnet-sdk) is an easy way to interact with our Server API from your .NET application. You can retrieve visitor history or individual identification events. View our [.NET Server SDK quickstart](/docs/dotnet-server-quickstart) for a step-by-step guide to get started.","href":"/reference/net-server-sdk"},{"title":"OpenAPI Schema","description":"[OpenAPI Specification](https://swagger.io/docs/specification/about/) (formerly *Swagger Specification*) is an API description format for REST APIs. With the open-source Fingerprint Server API and Webhooks [OpenAPI schemas](https://github.com/fingerprintjs/openapi), you can integrate Fingerprint's [Server API](/reference/server-api) and [Webhooks](/reference/posteventwebhook) into your server.","href":"/reference/openapi-schema"}]}]},{"tab":"Changelogs","icon":"history","groups":[{"group":"Changelogs","icon":"history","pages":[{"title":"JavaScript agent","icon":"js","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint documentation, in chronological order.","href":"/docs/changelog-javascript-agent"},{"title":"Android SDK","icon":"android","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint Android SDK, in chronological order.","href":"/docs/changelog-android-sdk"},{"title":"iOS SDK","icon":"apple","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint iOS SDK, in chronological order.","href":"/docs/changelog-ios-sdk"},{"title":"Smart Signals","icon":"zap","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint Smart Signals documentation, in chronological order.","href":"/docs/changelog-smart-signals"},{"title":"MCP server","icon":"plug","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint MCP server, in chronological order.","href":"/docs/changelog-mcp-server"},{"title":"Dashboard","icon":"layout-dashboard","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint Dashboard, in chronological order.","href":"/docs/changelog-dashboard"},{"title":"CLI","icon":"terminal","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint CLI, in chronological order.","href":"/docs/changelog-cli"}]}]}]},{"version":"v3","tag":"Deprecated","tabs":[{"tab":"Home","icon":"house","href":"/"},{"tab":"Start","icon":"play","groups":[{"group":"Getting started","pages":[{"noindex":true,"title":"Quick Start Guide","description":"How to quickly add Fingerprint device intelligence to your website or mobile app.","keywords":["configuration","setup","getting started"],"icon":"milestone","canonical":"https://docs.fingerprint.com/docs/quick-start-guide","href":"/docs/v3/quick-start-guide"},{"title":"Playground","url":"https://demo.fingerprint.com/playground","icon":"mouse-pointer-click","description":null,"href":"/docs/playground"},{"noindex":true,"title":"Use Case Tutorials","description":"Step-by-step tutorials for implementing Fingerprint in common fraud prevention scenarios","icon":"book-open","canonical":"https://docs.fingerprint.com/docs/use-case-tutorials-overview","href":"/docs/v3/use-case-tutorials-overview"}]},{"group":"Web","public":true,"icon":"monitor","pages":[{"noindex":true,"title":"JavaScript Quickstart","sidebarTitle":"JavaScript","icon":"js","description":"Get started using the JavaScript agent","canonical":"https://docs.fingerprint.com/docs/javascript-quickstart","href":"/docs/v3/javascript-quickstart"},{"noindex":true,"title":"React Quickstart","sidebarTitle":"React","icon":"react","description":"Get started using the Fingerprint React SDK","canonical":"https://docs.fingerprint.com/docs/react-quickstart","href":"/docs/v3/react-quickstart"},{"noindex":true,"title":"Next.js Quickstart","sidebarTitle":"Next.js","description":"Get started using the Fingerprint React SDK with Next.js","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/nextjs.svg","canonical":"https://docs.fingerprint.com/docs/nextjs-quickstart","href":"/docs/v3/nextjs-quickstart"},{"noindex":true,"title":"Preact Quickstart","sidebarTitle":"Preact","description":"Get started using the Fingerprint React SDK with Preact","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/preact.svg","canonical":"https://docs.fingerprint.com/docs/preact-quickstart","href":"/docs/v3/preact-quickstart"},{"noindex":true,"title":"Vue Quickstart","sidebarTitle":"Vue","icon":"vuejs","description":"Get started using the Fingerprint Vue SDK","canonical":"https://docs.fingerprint.com/docs/vue-quickstart","href":"/docs/v3/vue-quickstart"},{"noindex":true,"title":"Nuxt Quickstart","sidebarTitle":"Nuxt","description":"Get started using the Fingerprint Vue SDK with Nuxt","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/nuxt.svg","canonical":"https://docs.fingerprint.com/docs/nuxt-quickstart","href":"/docs/v3/nuxt-quickstart"},{"noindex":true,"title":"Angular Quickstart","sidebarTitle":"Angular","icon":"angular","description":"Get started using the Angular SDK","canonical":"https://docs.fingerprint.com/docs/angular-quickstart","href":"/docs/v3/angular-quickstart"},{"noindex":true,"title":"Svelte Quickstart","sidebarTitle":"Svelte","description":"Get started using the Fingerprint Svelte SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/svelte.svg","canonical":"https://docs.fingerprint.com/docs/svelte-quickstart","href":"/docs/v3/svelte-quickstart"}]},{"group":"Mobile","public":true,"icon":"smartphone","pages":[{"noindex":true,"title":"Android Quickstart","sidebarTitle":"Android","icon":"android","description":"Get started using the Android SDK","canonical":"https://docs.fingerprint.com/docs/android-quickstart","href":"/docs/v3/android-quickstart"},{"noindex":true,"title":"iOS Quickstart","sidebarTitle":"iOS","icon":"apple","description":"Get started using the iOS SDK","canonical":"https://docs.fingerprint.com/docs/ios-quickstart","href":"/docs/v3/ios-quickstart"},{"noindex":true,"title":"React Native Quickstart","sidebarTitle":"React Native","icon":"react","description":"Get started using the React Native SDK","canonical":"https://docs.fingerprint.com/docs/react-native-quickstart","href":"/docs/v3/react-native-quickstart"},{"noindex":true,"title":"Flutter Quickstart","sidebarTitle":"Flutter","icon":"flutter","description":"Get started using the Flutter SDK","canonical":"https://docs.fingerprint.com/docs/flutter-quickstart","href":"/docs/v3/flutter-quickstart"}]},{"group":"Server","public":true,"icon":"hard-drive","pages":[{"noindex":true,"title":"Node.js Server Quickstart","sidebarTitle":"Node.js","icon":"node","description":"Get started using the Node.js Server SDK","canonical":"https://docs.fingerprint.com/docs/node-server-quickstart","href":"/docs/v3/node-server-quickstart"},{"noindex":true,"title":"PHP Server Quickstart","sidebarTitle":"PHP","icon":"php","description":"Get started using the PHP Server SDK","canonical":"https://docs.fingerprint.com/docs/php-server-quickstart","href":"/docs/v3/php-server-quickstart"},{"noindex":true,"title":"C#/.NET Server Quickstart","sidebarTitle":"C#/.NET","description":"Get started using the C#/.NET Server SDK","icon":"https://mintlify.s3.us-west-1.amazonaws.com/fingerprint/icons/dotnet.svg","canonical":"https://docs.fingerprint.com/docs/dotnet-server-quickstart","href":"/docs/v3/dotnet-server-quickstart"},{"noindex":true,"title":"Go Server Quickstart","sidebarTitle":"Go","icon":"golang","description":"Get started using the Go Server SDK","canonical":"https://docs.fingerprint.com/docs/go-server-quickstart","href":"/docs/v3/go-server-quickstart"},{"noindex":true,"title":"Java Server Quickstart","sidebarTitle":"Java","description":"Get started using the Java Server SDK","icon":"java","canonical":"https://docs.fingerprint.com/docs/java-server-quickstart","href":"/docs/v3/java-server-quickstart"},{"noindex":true,"title":"Python Server Quickstart","sidebarTitle":"Python","icon":"python","description":"Get started using the Python Server SDK","canonical":"https://docs.fingerprint.com/docs/python-server-quickstart","href":"/docs/v3/python-server-quickstart"}]},{"group":"Use Case Tutorials","icon":"book-open","pages":[{"noindex":true,"title":"Account Sharing","description":"Learn how to detect and prevent unauthorized account sharing","canonical":"https://docs.fingerprint.com/docs/account-sharing-use-case-tutorial","href":"/docs/v3/account-sharing-use-case-tutorial"},{"noindex":true,"title":"Account Takeover","description":"Learn how to protect your application from account takeover attacks","canonical":"https://docs.fingerprint.com/docs/account-takeover-use-case-tutorial","href":"/docs/v3/account-takeover-use-case-tutorial"},{"noindex":true,"title":"Ban Enforcement","description":"Learn how to enforce user bans and prevent banned users from accessing your platform","canonical":"https://docs.fingerprint.com/docs/ban-enforcement-use-case-tutorial","href":"/docs/v3/ban-enforcement-use-case-tutorial"},{"noindex":true,"title":"Bonus Abuse","description":"Learn how to prevent bonus abuse and limit welcome offers to one per device","canonical":"https://docs.fingerprint.com/docs/bonus-abuse-use-case-tutorial","href":"/docs/v3/bonus-abuse-use-case-tutorial"},{"noindex":true,"title":"Card Testing","description":"Learn how to detect and prevent credit card testing fraud","canonical":"https://docs.fingerprint.com/docs/card-testing-use-case-tutorial","href":"/docs/v3/card-testing-use-case-tutorial"},{"noindex":true,"title":"Chargeback Dispute","description":"Learn how to reduce chargebacks and win disputes with device identification data","canonical":"https://docs.fingerprint.com/docs/chargeback-dispute-use-case-tutorial","href":"/docs/v3/chargeback-dispute-use-case-tutorial"},{"noindex":true,"title":"Coupon Abuse","description":"Learn how to prevent coupon abuse and protect your promotions from fraud","canonical":"https://docs.fingerprint.com/docs/coupon-abuse-use-case-tutorial","href":"/docs/v3/coupon-abuse-use-case-tutorial"},{"noindex":true,"title":"Credential Stuffing","description":"Learn how to protect your application from credential stuffing attacks","canonical":"https://docs.fingerprint.com/docs/credential-stuffing-use-case-tutorial","href":"/docs/v3/credential-stuffing-use-case-tutorial"},{"noindex":true,"title":"Loan Fraud","description":"Learn how to detect and prevent fraudulent loan applications","canonical":"https://docs.fingerprint.com/docs/loan-fraud-use-case-tutorial","href":"/docs/v3/loan-fraud-use-case-tutorial"},{"noindex":true,"title":"New Account Fraud","description":"Learn how to detect and prevent fraudulent account creation","canonical":"https://docs.fingerprint.com/docs/new-account-fraud-use-case-tutorial","href":"/docs/v3/new-account-fraud-use-case-tutorial"},{"noindex":true,"title":"Paywall Enforcement","description":"Learn how to implement paywall protection and prevent content bypass","canonical":"https://docs.fingerprint.com/docs/paywall-use-case-tutorial","href":"/docs/v3/paywall-use-case-tutorial"},{"noindex":true,"title":"Personalization","description":"Learn how to personalize experiences for anonymous visitors","canonical":"https://docs.fingerprint.com/docs/personalization-use-case-tutorial","href":"/docs/v3/personalization-use-case-tutorial"},{"noindex":true,"title":"Regional Pricing Enforcement","description":"Learn how to implement and enforce regional pricing","canonical":"https://docs.fingerprint.com/docs/regional-pricing-use-case-tutorial","href":"/docs/v3/regional-pricing-use-case-tutorial"},{"noindex":true,"title":"SMS Pumping","description":"Learn how to detect and prevent SMS pumping fraud","canonical":"https://docs.fingerprint.com/docs/sms-pumping-use-case-tutorial","href":"/docs/v3/sms-pumping-use-case-tutorial"},{"noindex":true,"title":"Survey Fraud","description":"Learn how to prevent survey fraud and ensure data quality","canonical":"https://docs.fingerprint.com/docs/survey-fraud-use-case-tutorial","href":"/docs/v3/survey-fraud-use-case-tutorial"},{"noindex":true,"title":"Web Scraping","description":"Learn how to detect and prevent unauthorized web scraping","canonical":"https://docs.fingerprint.com/docs/web-scraping-use-case-tutorial","href":"/docs/v3/web-scraping-use-case-tutorial"}]}]},{"tab":"AI","icon":"cpu","groups":[{"group":"AI tools","pages":[{"title":"Use Fingerprint with AI","sidebarTitle":"Overview","description":"Use AI coding agents and assistants to integrate Fingerprint, manage your workspace, and analyze identification data.","href":"/ai/overview"},{"title":"Fingerprint skills","sidebarTitle":"Skills","description":"Install Fingerprint skills to give your AI coding agent specialized knowledge about Fingerprint.","href":"/ai/skills"},{"title":"Fingerprint CLI","sidebarTitle":"CLI","description":"Integrate Fingerprint into your app and manage API keys and custom subdomains from your terminal.","href":"/ai/cli"},{"title":"Fingerprint MCP server","sidebarTitle":"MCP server","description":"Connect AI assistants and agents to Fingerprint device intelligence","href":"/ai/mcp-server"}]}]},{"tab":"Guides","icon":"book-open","groups":[{"group":"Understanding Fingerprint","icon":"info","pages":[{"noindex":true,"title":"Introduction","description":"Learn how you can prevent fraud and improve user experiences with Fingerprint.","canonical":"https://docs.fingerprint.com/docs/introduction","href":"/docs/v3/introduction"},{"noindex":true,"title":"Planning your implementation","description":"Key considerations to think through before implementing Fingerprint","canonical":"https://docs.fingerprint.com/docs/planning-implementation","href":"/docs/v3/planning-implementation"},{"noindex":true,"title":"Identification, accuracy, and confidence score","description":"Learn about the different methods Fingerprint uses to identify visitors, how Fingerprint defines and maintains accuracy, and how to use confidence score in your applications.","canonical":"https://docs.fingerprint.com/docs/identification-accuracy-and-confidence","href":"/docs/v3/identification-accuracy-and-confidence"},{"noindex":true,"title":"Privacy and compliance","description":"Overview of Fingerprint's regulatory compliance and how we ensure secure and responsible visitor identification.","canonical":"https://docs.fingerprint.com/docs/privacy-and-compliance","href":"/docs/v3/privacy-and-compliance"},{"noindex":true,"title":"Regions and data retention","description":"Learn more about where and how we store the identification data of your visitors.","canonical":"https://docs.fingerprint.com/docs/regions","href":"/docs/v3/regions"},{"noindex":true,"title":"Browser and device support","description":"An overview of Fingerprint compatibility across various browsers and devices.","canonical":"https://docs.fingerprint.com/docs/browser-and-device-support","href":"/docs/v3/browser-and-device-support"},{"group":"Billing and account limits explained","pages":[{"noindex":true,"title":"Billing and account limits explained","description":"A guide to understanding our API request-based billing and related concepts.","canonical":"https://docs.fingerprint.com/docs/billing","href":"/docs/v3/billing"},{"noindex":true,"title":"Troubleshooting Unexpected Usage Spikes","description":"If you're seeing a sudden spike in Fingerprint usage, it usually comes down to two main causes: implementation issues or malicious traffic. This guide will help you quickly diagnose and resolve the issue.","canonical":"https://docs.fingerprint.com/docs/troubleshooting-unexpected-usage-spikes","href":"/docs/v3/troubleshooting-unexpected-usage-spikes"}]},{"group":"Using the dashboard","pages":[{"noindex":true,"title":"Overview","description":"A guide to understanding the web-based interface for managing your Fingerprint account.","canonical":"https://docs.fingerprint.com/docs/using-the-dashboard","href":"/docs/v3/using-the-dashboard"},{"noindex":true,"title":"Analytics","canonical":"https://docs.fingerprint.com/docs/analytics","description":null,"href":"/docs/v3/analytics"},{"noindex":true,"title":"Bots and AI agents","description":"Analyze bot and AI agent traffic in the Fingerprint Dashboard, and investigate individual automation events.","canonical":"https://docs.fingerprint.com/docs/dashboard-bots-ai-agents","href":"/docs/v3/dashboard-bots-ai-agents"},{"noindex":true,"title":"Configuring resources","description":"The Dashboard allows you to manage all the resources and settings that govern how your Fingerprint implementation operates.","canonical":"https://docs.fingerprint.com/docs/configuration","href":"/docs/v3/configuration"},{"noindex":true,"title":"Monitoring health","canonical":"https://docs.fingerprint.com/docs/health","description":null,"href":"/docs/v3/health"},{"noindex":true,"title":"Workspaces \u0026 environments","canonical":"https://docs.fingerprint.com/docs/workspaces-environments","description":null,"href":"/docs/v3/workspaces-environments"},{"noindex":true,"title":"Roles \u0026 permissions","canonical":"https://docs.fingerprint.com/docs/roles-permissions","description":null,"href":"/docs/v3/roles-permissions"},{"noindex":true,"title":"User preferences","canonical":"https://docs.fingerprint.com/docs/user-preferences","description":null,"href":"/docs/v3/user-preferences"}]}]},{"group":"Identify browsers","icon":"monitor","pages":[{"group":"Install the JavaScript agent","pages":[{"noindex":true,"title":"Overview","description":"Learn how to install and use the JavaScript agent to identify visitors.","canonical":"https://docs.fingerprint.com/docs/install-the-javascript-agent","href":"/docs/v3/install-the-javascript-agent"},{"noindex":true,"title":"Configure Content Security Policy (CSP)","canonical":"https://docs.fingerprint.com/docs/js-agent-csp","description":null,"href":"/docs/v3/js-agent-csp"},{"noindex":true,"title":"Optimize JavaScript agent usage","description":"A collection of techniques to optimize your usage of the JavaScript agent. With a few adjustments, you can reduce latency and decrease the number of API calls required for your use case.","canonical":"https://docs.fingerprint.com/docs/optimize-javascript-agent","href":"/docs/v3/optimize-javascript-agent"},{"noindex":true,"title":"Usage with server-side rendering frameworks","description":"Learn how to use Fingerprint with server-side rendering frameworks.","canonical":"https://docs.fingerprint.com/docs/usage-with-server-side-rendering-frameworks","href":"/docs/v3/usage-with-server-side-rendering-frameworks"}]},{"noindex":true,"title":"Identify visitors","description":"Learn best practices for timing identification requests, caching visitor information or using linked IDs to associate your own identifiers with each visitor ID.","canonical":"https://docs.fingerprint.com/docs/identify-visitors","href":"/docs/v3/identify-visitors"},{"title":"JavaScript Agent API Reference","url":"/reference/v3/javascript-agent","description":null,"href":"/docs/v3/javascript-agent"},{"group":"Frontend libraries","pages":[{"noindex":true,"title":"Overview","description":"Fingerprint offers SDKs for the most popular client-side frameworks and libraries.","keywords":["angular","chrome-extension","nextjs","preact","react","svelte","vue"],"canonical":"https://docs.fingerprint.com/docs/frontend-libraries","href":"/docs/v3/frontend-libraries"},{"noindex":true,"title":"Angular SDK","canonical":"https://docs.fingerprint.com/docs/angular","description":null,"href":"/docs/v3/angular"},{"noindex":true,"title":"Google Chrome Extension","canonical":"https://docs.fingerprint.com/docs/fingerprintjs-pro-and-chrome-extension","description":null,"href":"/docs/v3/fingerprintjs-pro-and-chrome-extension"},{"noindex":true,"title":"Next","canonical":"https://docs.fingerprint.com/docs/fingerprintjs-pro-nextjs","description":null,"href":"/docs/v3/fingerprintjs-pro-nextjs"},{"noindex":true,"title":"Preact","canonical":"https://docs.fingerprint.com/docs/preact","description":null,"href":"/docs/v3/preact"},{"noindex":true,"title":"React","canonical":"https://docs.fingerprint.com/docs/react","description":null,"href":"/docs/v3/fingerprintjs-pro-react"},{"noindex":true,"title":"Svelte","canonical":"https://docs.fingerprint.com/docs/svelte","description":null,"href":"/docs/v3/svelte"},{"noindex":true,"title":"Vue","canonical":"https://docs.fingerprint.com/docs/vuejs","description":null,"href":"/docs/v3/vuejs"},{"noindex":true,"title":"Generic JavaScript agent wrapper for SPAs","canonical":"https://docs.fingerprint.com/docs/generic-js-agent-wrapper-for-spas","description":null,"href":"/docs/v3/generic-js-agent-wrapper-for-spas"}]}]},{"group":"Identify mobile devices","icon":"smartphone","pages":[{"noindex":true,"title":"Fingerprint for mobile devices","canonical":"https://docs.fingerprint.com/docs/mobile-identification","description":null,"href":"/docs/v3/mobile-identification"},{"group":"iOS devices","pages":[{"noindex":true,"title":"iOS devices","description":"Fingerprint's device intelligence platform for iOS devices.","canonical":"https://docs.fingerprint.com/docs/ios","href":"/docs/v3/ios"},{"noindex":true,"title":"Understanding privacy manifest files","canonical":"https://docs.fingerprint.com/docs/mobile-devices-understanding-privacy-manifest-files","description":null,"href":"/docs/v3/mobile-devices-understanding-privacy-manifest-files"}]},{"group":"Android devices","pages":[{"noindex":true,"title":"Overview","description":"Fingerprint's device intelligence platform for Android devices.","canonical":"https://docs.fingerprint.com/docs/native-android-integration","href":"/docs/v3/native-android-integration"},{"noindex":true,"title":"Android API call allowance","description":"Prevent fraud in your Android apps for free with Fingerprint device intelligence.","canonical":"https://docs.fingerprint.com/docs/android-api-call-allowance","href":"/docs/v3/android-api-call-allowance"}]},{"group":"Mobile SDKs","pages":[{"noindex":true,"title":"Overview","canonical":"https://docs.fingerprint.com/docs/mobile-sdks","description":null,"href":"/docs/v3/mobile-sdks"},{"noindex":true,"title":"iOS SDK","description":"A simple guide to integrate Fingerprint's device intelligence platform in your native iOS apps.","canonical":"https://docs.fingerprint.com/docs/ios-sdk","href":"/docs/v3/ios-sdk"},{"noindex":true,"title":"Android SDK","description":"A simple guide to integrate Fingerprint's device intelligence platform in your native Android apps.","canonical":"https://docs.fingerprint.com/docs/android-sdk","href":"/docs/v3/android-sdk"},{"noindex":true,"title":"React Native","canonical":"https://docs.fingerprint.com/docs/react-native","description":null,"href":"/docs/v3/fingerprintjs-pro-react-native"},{"noindex":true,"title":"Flutter","canonical":"https://docs.fingerprint.com/docs/flutter","description":null,"href":"/docs/v3/flutter"}]}]},{"group":"AI detection","icon":"cpu","pages":[{"noindex":true,"title":"AI agent detection","description":"Detect and verify AI agents visiting your web properties, and distinguish them from malicious bots.","canonical":"https://docs.fingerprint.com/docs/ai-agents","href":"/docs/v3/ai-agents"}]},{"group":"Protect your implementation","icon":"shield","pages":[{"group":"Evading ad blockers with proxy integrations","pages":[{"noindex":true,"title":"Overview","canonical":"https://docs.fingerprint.com/docs/protecting-the-javascript-agent-from-adblockers","description":null,"href":"/docs/v3/protecting-the-javascript-agent-from-adblockers"},{"group":"Custom Subdomain","pages":[{"noindex":true,"title":"Custom subdomain setup","canonical":"https://docs.fingerprint.com/docs/custom-subdomain-setup","description":null,"href":"/docs/v3/custom-subdomain-setup"},{"noindex":true,"title":"Migrate a legacy subdomain certificate","description":"Move your custom subdomain to the current SSL certificate setup without changing your subdomain or JavaScript agent configuration.","canonical":"https://docs.fingerprint.com/docs/legacy-subdomain-certificate-migration","href":"/docs/v3/legacy-subdomain-certificate-migration"}]},{"group":"Cloudflare Proxy Integration","pages":[{"noindex":true,"title":"Overview","description":"Fingerprint JavaScript agent v3.6.0 or later is required.","canonical":"https://docs.fingerprint.com/docs/cloudflare-integration","href":"/docs/v3/cloudflare-integration"},{"noindex":true,"title":"Blocking Origins and IPs","canonical":"https://docs.fingerprint.com/docs/cloudflare-integration-blocking-ips-and-origins","description":null,"href":"/docs/v3/cloudflare-integration-blocking-ips-and-origins"}]},{"group":"AWS Cloudfront Proxy Integration V2","pages":[{"noindex":true,"title":"Overview","canonical":"https://docs.fingerprint.com/docs/cloudfront-proxy-integration-v2","description":null,"href":"/docs/v3/cloudfront-proxy-integration-v2"},{"noindex":true,"title":"Install CloudFront Integration using CloudFormation","canonical":"https://docs.fingerprint.com/docs/install-cloudfront-integration-using-cloudformation","description":null,"href":"/docs/v3/install-cloudfront-integration-using-cloudformation"},{"noindex":true,"title":"Install CloudFront Integration using Terraform","canonical":"https://docs.fingerprint.com/docs/aws-cloudfront-integration-via-terraform","description":null,"href":"/docs/v3/aws-cloudfront-integration-via-terraform"},{"noindex":true,"title":"Migrating CloudFront proxy integration from v1 to v2","canonical":"https://docs.fingerprint.com/docs/cloudfront-integration-migration-to-js-agent-v4","description":null,"href":"/docs/v3/cloudfront-integration-migration-from-v1-to-v2"}]},{"group":"Fastly VCL Proxy Integration","pages":[{"noindex":true,"title":"Overview","canonical":"https://docs.fingerprint.com/docs/fastly-vcl-proxy-integration","description":null,"href":"/docs/v3/fastly-vcl-proxy-integration"},{"noindex":true,"title":"Deploy Fastly VCL Manually","canonical":"https://docs.fingerprint.com/docs/deploy-fastly-vcl-manually","description":null,"href":"/docs/v3/deploy-fastly-vcl-manually"},{"noindex":true,"title":"Deploy Fastly VCL using Terraform Module","canonical":"https://docs.fingerprint.com/docs/deploy-fastly-vcl-using-terraform","description":null,"href":"/docs/v3/deploy-fastly-vcl-using-terraform"}]},{"group":"Fastly Compute Proxy Integration","pages":[{"noindex":true,"title":"Overview","canonical":"https://docs.fingerprint.com/docs/fastly-compute-proxy-integration","description":null,"href":"/docs/v3/fastly-compute-proxy-integration"},{"noindex":true,"title":"Fastly Compute Proxy Integration Open Response Plugins","description":"Process identification results directly in your Fastly Compute proxy","href":"/docs/v3/using-open-client-response-with-fastly-compute-proxy-integration-plugins"},{"noindex":true,"title":"Deploy Fastly Compute Proxy Integration Manually","canonical":"https://docs.fingerprint.com/docs/deploy-fastly-compute-manually","description":null,"href":"/docs/v3/deploy-fastly-compute-manually"},{"noindex":true,"title":"Deploy Fastly Compute Proxy Integration with Terraform","canonical":"https://docs.fingerprint.com/docs/deploy-fastly-compute-using-terraform","description":null,"href":"/docs/v3/deploy-fastly-compute-using-terraform"}]},{"group":"Akamai Proxy Integration","pages":[{"noindex":true,"title":"Overview","canonical":"https://docs.fingerprint.com/docs/akamai-proxy-integration","description":null,"href":"/docs/v3/akamai-proxy-integration"},{"noindex":true,"title":"Deploy Akamai Integration using Terraform","description":"The recommended way to deploy Fingerprint Akamai proxy integration is to use Terraform","canonical":"https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-terraform","href":"/docs/v3/deploy-akamai-proxy-integration-via-terraform"},{"noindex":true,"title":"Deploy Akamai Integration using Property Manager API","description":"Deploy the Fingerprint Akamai Proxy Integration using Akamai Property Manager API PATCH body method.","canonical":"https://docs.fingerprint.com/docs/deploy-akamai-proxy-integration-via-papi","href":"/docs/v3/deploy-akamai-proxy-integration-via-papi"},{"noindex":true,"title":"Troubleshoot 503 errors in Akamai Proxy Integration","description":"Fix 503 errors between Akamai and Fingerprint endpoints by aligning Origin SSL verification settings in your Akamai property rules.","canonical":"https://docs.fingerprint.com/docs/troubleshooting-akamai-supernet-error","href":"/docs/v3/troubleshooting-akamai-supernet-error"}]},{"noindex":true,"title":"Azure Proxy Integration (deprecated)","canonical":"https://docs.fingerprint.com/docs/azure-proxy-integration","description":null,"href":"/docs/v3/azure-proxy-integration"}]},{"noindex":true,"title":"Protecting from client-side tampering and replay attacks","description":"Prevent malicious users from bypassing Fingerprint by integrating it with your","canonical":"https://docs.fingerprint.com/docs/protecting-from-client-side-tampering","href":"/docs/v3/protecting-from-client-side-tampering"},{"group":"Request filtering","pages":[{"noindex":true,"title":"Request filtering","description":"Block unwanted identification requests to prevent malicious actors from misusing your Fingerprint public API keys.","canonical":"https://docs.fingerprint.com/docs/request-filtering","href":"/docs/v3/request-filtering"},{"noindex":true,"title":"Request filtering for websites","canonical":"https://docs.fingerprint.com/docs/request-filtering-for-websites","description":null,"href":"/docs/v3/request-filtering-for-websites"},{"noindex":true,"title":"Request filtering for mobile apps","canonical":"https://docs.fingerprint.com/docs/mobile-app-filtering","description":null,"href":"/docs/v3/mobile-app-filtering"},{"noindex":true,"title":"Search bot request filtering","description":"Allow basic search bots filtering through a single switch in the Request Filtering Dashboard section","canonical":"https://docs.fingerprint.com/docs/search-bots-filtering","href":"/docs/v3/search-bots-filtering"},{"noindex":true,"title":"AI bot request filtering","description":"Allow basic AI bots filtering through a single switch in the Request Filtering","canonical":"https://docs.fingerprint.com/docs/ai-bot-filtering","href":"/docs/v3/ai-bot-filtering"},{"noindex":true,"title":"Network request filtering","description":"Filter unwanted traffic based on a list of source IP addresses","canonical":"https://docs.fingerprint.com/docs/network-request-filtering","href":"/docs/v3/network-request-filtering"},{"group":"(Beta) Request Filtering V2","pages":[{"noindex":true,"title":"(Beta) Request filtering V2","description":"Block unwanted identification requests to prevent malicious actors from misusing your Fingerprint public API keys.","canonical":"https://docs.fingerprint.com/docs/request-filtering-v2","href":"/docs/v3/request-filtering-v2"},{"noindex":true,"title":"Expression language reference","description":"Rule expressions are written using a simple expression language. It provides a rich set of operators and builtin functions, and allows you to create flexible conditions and criteria.","canonical":"https://docs.fingerprint.com/docs/expression-language-reference","href":"/docs/v3/expression-language-reference"}]}]},{"noindex":true,"title":"Protecting from payload replay attacks","description":"Identify malicious actors that capture and replay the client-side request payload using the replayed flag.","canonical":"https://docs.fingerprint.com/docs/protecting-from-payload-replay-attacks","href":"/docs/v3/protecting-from-payload-replay-attacks"}]},{"group":"Integrate with your server","icon":"hard-drive","pages":[{"noindex":true,"title":"Get server side intelligence","canonical":"https://docs.fingerprint.com/docs/get-server-side-intelligence","description":null,"href":"/docs/v3/get-server-side-intelligence"},{"title":"Server API","url":"/reference/v3/server-api","description":null,"href":"/docs/v3/server-api"},{"noindex":true,"title":"Webhooks","description":"Receive an HTTP request to your server with Fingerprint results for every identification event the moment it happens.","canonical":"https://docs.fingerprint.com/docs/webhooks","href":"/docs/v3/webhooks"},{"noindex":true,"title":"Sealed Client Results","description":"Receive an encrypted payload in the JavaScript agent with all information available in the /events endpoint, meant to be decrypted and used on your backend.","canonical":"https://docs.fingerprint.com/docs/sealed-client-results","href":"/docs/v3/sealed-client-results"},{"noindex":true,"title":"Zero Trust Mode","canonical":"https://docs.fingerprint.com/docs/zero-trust-mode","description":null,"href":"/docs/v3/zero-trust-mode"},{"title":"Management API","url":"/reference/management-api","description":null,"href":"/docs/management-api"},{"group":"Data integrations","pages":[{"noindex":true,"title":"Google Tag Manager","canonical":"https://docs.fingerprint.com/docs/fingerprintjs-pro-google-tag-manager","description":null,"href":"/docs/v3/fingerprintjs-pro-google-tag-manager"},{"noindex":true,"title":"Matomo / Piwik","description":"Learn how to use Matomo (formerly Piwik) with Fingerprint to identify visitors.","canonical":"https://docs.fingerprint.com/docs/matomo-piwik","href":"/docs/v3/matomo-piwik"},{"noindex":true,"title":"Segment Data Integration","canonical":"https://docs.fingerprint.com/docs/segment","description":null,"href":"/docs/v3/segment"}]},{"noindex":true,"title":"Open Client Response","description":"Read the full device intelligence result in-flight on your proxy integration for faster and more secure processing.","href":"/docs/v3/open-client-response"}]},{"group":"Integrate Smart Signals","icon":"zap","pages":[{"title":"Smart Signals introduction","noindex":true,"description":"Smart Signals give you actionable device intelligence for browsers and devices","canonical":"https://docs.fingerprint.com/docs/smart-signals-introduction","href":"/docs/v3/smart-signals-introduction"},{"title":"Smart Signals reference","noindex":true,"description":"Fingerprint is not just an identity platform; it also helps fight fraud by providing actionable device intelligence called Smart Signals. This page contains the reference information for individual Smart Signal components and their applications.","canonical":"https://docs.fingerprint.com/docs/smart-signals-reference","href":"/docs/v3/smart-signals-reference"},{"title":"Suspect Score","noindex":true,"description":"Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow. It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity.","canonical":"https://docs.fingerprint.com/docs/suspect-score","href":"/docs/v3/suspect-score"},{"group":"Bot Detection","public":true,"pages":[{"noindex":true,"title":"Bot Detection Overview","description":"Overview of Fingerprint bot detection for browsers and AI agents","canonical":"https://docs.fingerprint.com/docs/bot-detection/overview","href":"/docs/v3/bot-detection/overview"},{"noindex":true,"title":"Bot Directory","description":"This directory lists bots Fingerprint can detect. This is not an exhaustive list, more bots are coming soon.","canonical":"https://docs.fingerprint.com/docs/bot-detection/bot-directory","href":"/docs/v3/bot-detection/bot-directory"},{"noindex":true,"title":"Web Bot Auth Implementation","description":"Web Bot Auth is used as a verification method for verified bots and signed agents.","canonical":"https://docs.fingerprint.com/docs/bot-detection/web-bot-auth-implementation","href":"/docs/v3/bot-detection/web-bot-auth-implementation"}]}]},{"group":"Tips and advanced guides","icon":"lightbulb","pages":[{"noindex":true,"title":"Linking and tagging information","canonical":"https://docs.fingerprint.com/docs/tagging-information","description":null,"href":"/docs/v3/tagging-information"},{"noindex":true,"title":"Multiple environments","canonical":"https://docs.fingerprint.com/docs/multiple-environments","description":null,"href":"/docs/v3/multiple-environments"},{"noindex":true,"title":"Identification using pseudonymized IP Address","canonical":"https://docs.fingerprint.com/docs/identification-using-pseudonymized-ip-address","description":null,"href":"/docs/v3/identification-using-pseudonymized-ip-address"},{"noindex":true,"title":"Identifying in-app browsers for iOS","canonical":"https://docs.fingerprint.com/docs/identifying-in-app-browsers-for-ios","description":null,"href":"/docs/v3/identifying-in-app-browsers-for-ios"},{"noindex":true,"title":"Identifying users in hybrid app frameworks","canonical":"https://docs.fingerprint.com/docs/identifying-users-in-hybrid-app-frameworks","description":null,"href":"/docs/v3/identifying-users-in-hybrid-app-frameworks"},{"noindex":true,"title":"Visitor footprint timestamps","canonical":"https://docs.fingerprint.com/docs/useful-timestamps","description":null,"href":"/docs/v3/useful-timestamps"}]},{"group":"Platform updates","icon":"history","pages":[{"title":"Changelog (JavaScript agent)","url":"/docs/changelog-javascript-agent","description":null,"href":"/docs/changelog"},{"title":"Android SDK Changelog","url":"/docs/changelog-android-sdk","description":null,"href":"/docs/android-sdk-changelog"},{"title":"iOS SDK Changelog","url":"/docs/changelog-ios-sdk","description":null,"href":"/docs/ios-sdk-changelog"}]},{"group":"Resources","icon":"circle-question-mark","pages":[{"title":"Discord Server","url":"https://discord.gg/ad6R2ttHVX","description":null,"href":"/docs/discord"},{"title":"Status Page","url":"https://status.fingerprint.com/","description":null,"href":"/docs/status"},{"title":"Product Roadmap","url":"https://roadmap.fingerprint.com/","description":null,"href":"/docs/product-roadmap"},{"noindex":true,"title":"Glossary","canonical":"https://docs.fingerprint.com/docs/glossary","description":null,"href":"/docs/v3/glossary"},{"noindex":true,"title":"Migrating from FingerprintJS to Fingerprint","canonical":"https://docs.fingerprint.com/docs/migrating-from-fingerprintjs-to-fingerprint-pro","description":null,"href":"/docs/v3/migrating-from-fingerprintjs-to-fingerprint-pro"}]},{"group":"Legal","icon":"gavel","pages":[{"title":"Terms of service","description":"Effective date: Nov 1, 2026. | [Archived Versions](/docs/legal-archive)","href":"/docs/terms-of-service"},{"title":"Privacy policy","description":"Effective date: November 1, 2026. | [Archived Versions](/docs/legal-archive)","href":"/docs/privacy-policy"},{"title":"DPA (GDPR)","description":null,"href":"/docs/dpa-gdpr"}]}]},{"tab":"API Reference","icon":"code","groups":[{"group":"JavaScript Agent","pages":[{"group":"JavaScript Agent","pages":[{"noindex":true,"title":"Overview","description":"The Fingerprint JavaScript agent is a high-performance JavaScript function that collects multiple device and browser signals and sends them to the Fingerprint Platform API for visitor identification and device intelligence analysis.","canonical":"https://docs.fingerprint.com/reference/js-agent","href":"/reference/v3/javascript-agent"},{"noindex":true,"title":"load function","description":"API reference for the JavaScript agent's function","canonical":"https://docs.fingerprint.com/reference/js-agent-start-function","href":"/reference/v3/js-agent-load-function"},{"noindex":true,"title":"get function","description":"This page contains the API Reference for the JavaScript agent's function or its equivalent in your frontend library. The function is exported directly from the NPM package. Instead, it is a method on the agent instance returned by the function.","canonical":"https://docs.fingerprint.com/reference/js-agent-get-function","href":"/reference/v3/js-agent-get-function"}]},{"noindex":true,"title":"Error handling","description":"This page contains a reference for errors, timeouts, and other potential problems you can encounter while using the JavaScript agent.","canonical":"https://docs.fingerprint.com/reference/js-agent-error-handling","href":"/reference/v3/js-agent-error-handling"}]},{"group":"Server API","pages":[{"noindex":true,"title":"Server API","description":"Fingerprint Server API enables you to get more information about your visitors or about individual identification events.","canonical":"https://docs.fingerprint.com/reference/server-api","href":"/reference/v3/server-api"},{"group":"Events","expanded":true,"pages":[{"noindex":true,"openapi":"reference/v3/server-api.json GET /events/{request_id}","deprecated":true,"canonical":"https://docs.fingerprint.com/reference/server-api-get-event","title":"Get event by request ID","description":"> 🚧 Deprecation Notice\n>\n> Server API v3 is deprecated as of **October 31, 2026**, and stops working on **October 31, 2027**, according to the [API Deprecation Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If you still use v3, follow the [migration guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-/events) to move to v4 before that date.\n\nGet a detailed analysis of an individual identification event, including Smart Signals. \nPlease note that the response includes mobile signals (e.g. `rootApps`) even if the request originated from a non-mobile platform.\nIt is highly recommended that you **ignore** the mobile signals for such requests. \n\nUse `requestId` as the URL path parameter. This API method is scoped to a request, i.e. all returned information is by `requestId`.\n","href":"/reference/v3/server-api-get-event"},{"noindex":true,"openapi":"reference/v3/server-api.json PUT /events/{request_id}","deprecated":true,"canonical":"https://docs.fingerprint.com/reference/server-api-update-event","title":"Update an event with a given request ID","description":"> 🚧 Deprecation Notice\n>\n> Server API v3 is deprecated as of **October 31, 2026**, and stops working on **October 31, 2027**, according to the [API Deprecation Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If you still use v3, follow the [migration guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-update-/events) to move to v4 before that date.\n\nChange information in existing events specified by `requestId` or *flag suspicious events*.\n\nWhen 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.\n\n**Warning** It's not possible to update events older than 10 days.\n","href":"/reference/v3/server-api-update-event"}]},{"group":"Event Search","expanded":true,"pages":[{"noindex":true,"openapi":"reference/v3/server-api.json GET /events/search","deprecated":true,"canonical":"https://docs.fingerprint.com/reference/server-api-search-events","title":"Get events via search","description":"> 🚧 Deprecation Notice\n>\n> Server API v3 is deprecated as of **October 31, 2026**, and stops working on **October 31, 2027**, according to the [API Deprecation Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If you still use v3, follow the [migration guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-/events/search) to move to v4 before that date.\n\nSearch 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.\n\nPlease 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.\n","href":"/reference/v3/server-api-search-events"}]},{"group":"Visitors","expanded":true,"pages":[{"noindex":true,"openapi":"reference/v3/server-api.json GET /visitors/{visitor_id}","deprecated":true,"canonical":"https://docs.fingerprint.com/reference/server-api-search-events","title":"Get visits by visitor ID","description":"> 🚧 Deprecation Notice\n>\n> Server API v3 is deprecated as of **October 31, 2026**, and stops working on **October 31, 2027**, according to the [API Deprecation Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If you still use v3, follow the [migration guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4#migrating-get-/visitors) to move to v4 before that date.\n\nThis endpoint is deprecated. Use `GET /events/search` to query visit history or filter across multiple events.\n\n`GET /visitors/{visitor_id}` currently returns at most one visit in `visits`, even when no filters are provided.\nOnly information from the _Identification_ product is returned.\n\n#### Headers\n\n* `Retry-After` — Present in case of `429 Too many requests`. Indicates how long you should wait before making a follow-up request. The value is non-negative decimal integer indicating the seconds to delay after the response is received.\n","href":"/reference/v3/server-api-get-visits"},{"noindex":true,"openapi":"reference/v3/server-api.json DELETE /visitors/{visitor_id}","deprecated":true,"canonical":"https://docs.fingerprint.com/reference/server-api-delete-visitor-id","title":"Delete data by visitor ID","description":"> 🚧 Deprecation Notice\n>\n> Server API v3 is deprecated as of **October 31, 2026**, and stops working on **October 31, 2027**, according to the [API Deprecation Policy](https://docs.fingerprint.com/reference/api-deprecation-policy). If you still use v3, follow the [migration guide](https://docs.fingerprint.com/reference/migrating-from-server-api-v3-to-v4) to move to v4 before that date.\n\nRequest deleting all data associated with the specified visitor ID. This API is useful for compliance with privacy regulations.\n### Which data is deleted?\n- Browser (or device) properties\n- Identification requests made from this browser (or device)\n\n#### Browser (or device) properties\n- Represents the data that Fingerprint collected from this specific browser (or device) and everything inferred and derived from it.\n- Upon request to delete, this data is deleted asynchronously (typically within a few minutes) and it will no longer be used to identify this browser (or device) for your [Fingerprint Workspace](https://docs.fingerprint.com/docs/v3/glossary#fingerprint-workspace).\n\n#### Identification requests made from this browser (or device)\n- Fingerprint stores the identification requests made from a browser (or device) for up to 30 (or 90) days depending on your plan. To learn more, see [Data Retention](https://docs.fingerprint.com/docs/v3/regions#data-retention).\n- Upon request to delete, the identification requests that were made by this browser\n - Within the past 10 days are deleted within 24 hrs.\n - Outside of 10 days are allowed to purge as per your data retention period.\n\n### Corollary\nAfter requesting to delete a visitor ID,\n- If the same browser (or device) requests to identify, it will receive a different visitor ID.\n- If you request [`/events` API](https://docs.fingerprint.com/reference/v3/server-api-get-event) with a `request_id` that was made outside of the 10 days, you will still receive a valid response.\n- If you request [`/visitors` API](https://docs.fingerprint.com/reference/v3/server-api-get-visits) for the deleted visitor ID, the response will include identification requests that were made outside of those 10 days.\n\n### Interested?\nPlease [contact our support team](https://fingerprint.com/support/) to enable it for you. Otherwise, you will receive a 403.\n","href":"/reference/v3/server-api-delete-visitor-id"}]}]},{"group":"Policy and Upgrades","pages":[{"title":"API Deprecation Policy","description":"At Fingerprint, we regularly release updates to our JavaScript agent, APIs, and SDKs, to give you more features, increased security, and better performance. Sometimes, this means older versions of our APIs will no longer be supported.","href":"/reference/api-deprecation-policy"},{"title":"Migrating from Server API v3 to v4","description":"Learn how to migrate your integration from the deprecated Server API v3 endpoints to the new, improved Server API v4. This guide covers endpoint changes, authentication updates, and best practices for a smooth transition.","href":"/reference/migrating-from-server-api-v3-to-v4"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","url":"/docs/v3/webhooks","description":null,"href":"/reference/v3/webhooks"}]},{"group":"Management API","expanded":true,"pages":[{"title":"Overview","description":"Management API allows you to manage your Fingerprint account and workspaces programmatically from a server environment.","href":"/reference/management-api"},{"title":"Authentication","description":"Management API requests are authorized by using the **Management API key**.","href":"/reference/management-api-authentication"},{"title":"Versioning","description":"Management API is *versioned*. When backwards-incompatible changes are made to the API, we release a new, dated version.","href":"/reference/management-api-versioning"},{"title":"Pagination","description":null,"href":"/reference/management-api-pagination"},{"title":"Changelog","description":"This changelog lists all additions and updates to the Management API, in chronological order.","href":"/reference/management-api-changelog"},{"group":"api-keys","expanded":true,"pages":[{"title":"List API keys","openapi":"reference/management-api_2025-11-20.json GET /api-keys","description":"Lists all API keys for the workspace associated with the Management API key.","href":"/reference/apikeyscontroller_findall"},{"title":"Create API key","openapi":"reference/management-api_2025-11-20.json POST /api-keys","description":"Creates an API key for the workspace associated with the Management API key. Maximum number of API keys in defined by your plan limits. If you need additional API keys, contact our support team.","href":"/reference/apikeyscontroller_create"},{"title":"Get API key","openapi":"reference/management-api_2025-11-20.json GET /api-keys/{id}","description":"Fetch an API key by ID.","href":"/reference/apikeyscontroller_findone"},{"title":"Update API key","openapi":"reference/management-api_2025-11-20.json PATCH /api-keys/{id}","description":"Updates a single API key. You can update the keys name, description, status, and rate limit. You cannot mutate the actual key itself.","href":"/reference/apikeyscontroller_update"},{"title":"Delete API key","openapi":"reference/management-api_2025-11-20.json DELETE /api-keys/{id}","description":"Deletes an API key with the given ID. Make sure that the key you are deleting is not used in production environment. This action is not reversible.","href":"/reference/apikeyscontroller_deleteapikey"}]},{"group":"environments","expanded":true,"pages":[{"title":"Create an environment","openapi":"reference/management-api_2025-11-20.json POST /environments","description":"Creates a new environment for the workspace associated with the Management API key. Maximum number of environments in defined by your plan limits. If you need additional environments, contact our support team.","href":"/reference/environmentcontroller_create"},{"title":"Delete an environment","openapi":"reference/management-api_2025-11-20.json DELETE /environments/{id}","description":"Deletes an environment with the given environment ID. You can only delete environments that don't have any active API keys associated with it.","href":"/reference/environmentcontroller_delete"},{"title":"Update an environment","openapi":"reference/management-api_2025-11-20.json POST /environments/{id}","description":"Updates an environment with the given environment ID. You can update the name, description, and limit settings.","href":"/reference/environmentcontroller_update"}]},{"group":"filtering-rules","expanded":true,"pages":[{"title":"Update filtering rule","url":"/reference/filteringrulesv2controller_update","description":null,"href":"/reference/v3/filteringrulescontroller_update"}]},{"group":"webhooks","expanded":true,"pages":[{"title":"List webhooks","url":"/reference/webhookscontroller_findallv2","description":null,"href":"/reference/v3/webhookscontroller_findall"},{"title":"Create a webhook","openapi":"reference/management-api_2025-11-20.json POST /webhooks","description":"Creates a new webhook in the workspace associated with the Management API key.\nWebhook needs to be verified before it will start sending identification events to your server. See webhook verification.\nIf webhook signatures are enabled (enterprise only), signing key will be visible in the response after creation. When fetching webhooks after creation, signing key will not be visible!\nSee webhooks documentation for more details.\nWhen specifying an environment during creation, webhook should be assigned to the given environment. Setting environment to null creates a global webhook.","href":"/reference/webhookscontroller_create"},{"title":"Get webhook by ID","openapi":"reference/management-api_2025-11-20.json GET /webhooks/{id}","description":"Fetch a specific webhook by ID.","href":"/reference/webhookscontroller_findone"},{"title":"Update webhook","openapi":"reference/management-api_2025-11-20.json PATCH /webhooks/{id}","description":"Updates the webhook with the given ID. You can update the name, description, status, URL, and set basic authentication.\nChanging the URL will require this webhook to be verified again.\nChanging the status will disable/enable sending of identification events to your webhook.","href":"/reference/webhookscontroller_update"},{"title":"Delete webhook","openapi":"reference/management-api_2025-11-20.json DELETE /webhooks/{id}","description":"Deletes the webhook with the given ID. This action is not reversible. Changes will take affect in a few minutes.","href":"/reference/webhookscontroller_remove"},{"title":"Verify webhook","openapi":"reference/management-api_2025-11-20.json POST /webhooks/{id}/verification","description":"Send a mocked test event in order to verify your webhook endpoint, it needs to respond with HTTP 200 to be verified.\nWebhook needs to be verified before it will receive identification events.","href":"/reference/webhookscontroller_verify"}]},{"group":"subdomains","expanded":true,"pages":[{"title":"Register a subdomain","openapi":"reference/management-api_2025-11-20.json POST /subdomains","description":"Register a new custom subdomain and receive its DNS records. Optionally pass `webhook_url` to get a signed POST callback on every status change instead of polling; the signing secret is returned once in this response as `webhook_secret`.","href":"/reference/subdomainscontroller_create"},{"title":"List subdomains","openapi":"reference/management-api_2025-11-20.json GET /subdomains","description":"Lists all custom subdomains for the workspace associated with the Management API key.","href":"/reference/subdomainscontroller_findall"},{"title":"Get subdomain","openapi":"reference/management-api_2025-11-20.json GET /subdomains/{id}","description":"Fetch a subdomain by ID.","href":"/reference/subdomainscontroller_findone"},{"title":"Verify subdomain","openapi":"reference/management-api_2025-11-20.json POST /subdomains/{id}/verify","description":"Trigger manual verification for a subdomain.","href":"/reference/subdomainscontroller_verify"},{"title":"Delete subdomain","openapi":"reference/management-api_2025-11-20.json DELETE /subdomains/{id}","description":"Delete a subdomain by ID.","href":"/reference/subdomainscontroller_delete"}]}]},{"group":"Server SDKs","pages":[{"noindex":true,"title":"Server SDKs","description":"Fingerprint offers SDKs for the most popular server-side frameworks and languages. The SDKs make it easier to work with Fingerprint Server API, Webhooks, and other features by providing utility methods and types.","canonical":"https://docs.fingerprint.com/reference/server-sdks","href":"/reference/v3/server-sdks"},{"noindex":true,"title":"Go Server SDK","description":"The [Fingerprint Server Go SDK](https://github.com/fingerprintjs/fingerprint-pro-server-api-go-sdk) is an easy way to interact with our Server API from your Go application. You can retrieve visitor history or individual identification events. View our [Go Server SDK quickstart](/docs/go-server-quickstart) for a step-by-step guide to get started.","canonical":"https://docs.fingerprint.com/reference/go-server-sdk","href":"/reference/v3/go-server-sdk"},{"noindex":true,"title":"Java Server SDK","description":"The [Fingerprint Server Java SDK](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk) is an easy way to interact with our Server API from your Java application. You can retrieve visitor history or individual identification events. View our [Java Server SDK quickstart](/docs/v3/java-server-quickstart) for a step-by-step guide to get started.","canonical":"https://docs.fingerprint.com/reference/java-server-sdk","href":"/reference/v3/java-server-sdk"},{"noindex":true,"title":"Node Server SDK","description":"The [Fingerprint Server Node SDK](https://github.com/fingerprintjs/node-sdk/tree/api-v3) is an easy way to interact with our Server API from your Node application. You can retrieve visitor history or individual identification events. View our [Node Server SDK quickstart](/docs/v3/node-server-quickstart) for a step-by-step guide to get started.","canonical":"https://docs.fingerprint.com/reference/node-server-sdk","href":"/reference/v3/node-server-sdk"},{"noindex":true,"title":"PHP Server SDK","description":"The PHP Server SDK is an easy way to interact with our Server API from your PHP application. You can retrieve visitor history or individual identification events. View our [PHP Server SDK quickstart](/docs/v3/php-server-quickstart) for a step-by-step guide to get started.","canonical":"https://docs.fingerprint.com/reference/php-server-sdk","href":"/reference/v3/php-server-sdk"},{"noindex":true,"title":"Python Server SDK","description":"[Fingerprint Server Python SDK](https://github.com/fingerprintjs/python-sdk/tree/api-v3) is an easy way to interact with our Server API from your Python application. You can retrieve visitor history or individual identification events. View our [Python Server SDK quickstart](/docs/v3/python-server-quickstart) for a step-by-step guide to get started.","canonical":"https://docs.fingerprint.com/reference/python-server-sdk","href":"/reference/v3/python-server-sdk"},{"noindex":true,"title":".NET Server SDK","description":"The [Fingerprint Server C#/.NET SDK](https://github.com/fingerprintjs/dotnet-sdk) is an easy way to interact with our Server API from your .NET application. You can retrieve visitor history or individual identification events. View our [.NET Server SDK quickstart](/docs/dotnet-server-quickstart) for a step-by-step guide to get started.","canonical":"https://docs.fingerprint.com/reference/net-server-sdk","href":"/reference/v3/net-server-sdk"},{"noindex":true,"title":"OpenAPI Schema","description":"[OpenAPI Specification](https://swagger.io/docs/specification/about/) (formerly *Swagger Specification*) is an API description format for REST APIs. With the Fingerprint Server API and Webhooks open-source [OpenAPI schema](https://github.com/fingerprintjs/openapi), you can integrate with Fingerprint's [Server API](/reference/v3/server-api) and [Webhooks](/reference/v3/webhooks) into your server.","canonical":"https://docs.fingerprint.com/reference/openapi-schema","href":"/reference/v3/openapi-schema"}]}]},{"tab":"Changelogs","icon":"history","groups":[{"group":"Changelogs","icon":"history","pages":[{"title":"JavaScript agent","icon":"js","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint documentation, in chronological order.","href":"/docs/changelog-javascript-agent"},{"title":"Android SDK","icon":"android","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint Android SDK, in chronological order.","href":"/docs/changelog-android-sdk"},{"title":"iOS SDK","icon":"apple","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint iOS SDK, in chronological order.","href":"/docs/changelog-ios-sdk"},{"title":"Smart Signals","icon":"zap","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint Smart Signals documentation, in chronological order.","href":"/docs/changelog-smart-signals"},{"title":"MCP server","icon":"plug","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint MCP server, in chronological order.","href":"/docs/changelog-mcp-server"},{"title":"Dashboard","icon":"layout-dashboard","rss":true,"description":"This changelog lists all additions and updates to the Fingerprint Dashboard, in chronological order.","href":"/docs/changelog-dashboard"}]}]}]}]},"basePath":"","title":"Collect Intelligence - Fingerprint Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}