Fingerprints

Generate unique identifiers for your users to create a reusable environment of user session data, proxy, cookies and device configuration.

GetFingerprint

get

Retrieves detailed information about a specific fingerprint, including its configuration, proxy settings, and session status.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
fingerprintUUIDstringRequiredExample: 4137e748-96ce-4354-94c6-8ebfbb48d756
Responses
200

Fingerprint details

application/json
get
/{mode}/v1/fingerprints/{fingerprintUUID}

ListFingerprints

get
Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
Query parameters
limitintegerOptionalExample: 100
Responses
200

List of fingerprints

application/json
get
/{mode}/v1/fingerprints

CreateFingerprint

post

Creates a new fingerprint with specified browser configuration, device settings, and proxy settings. This fingerprint can be used to start new browser sessions.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
Body
environmentUUIDstring ยท uuidRequired
extensionsstring[]OptionalDefault: []
Responses
200

Created fingerprint

application/json
Responseall of
post
/{mode}/v1/fingerprints

CreateRandomFingerprint

post

Generates a new fingerprint with randomized browser configuration, device settings, and proxy settings.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
Body
environmentUUIDstring ยท uuidRequired

UUID of the environment to create the fingerprint in

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200

Created random fingerprint

application/json
Responseall of
post
/{mode}/v1/fingerprints/random

ArchiveFingerprint

post

Archives a fingerprint by deleting all associated session data and marking it as no longer usable. Once archived, the fingerprint cannot be used to create new sessions.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
fingerprintUUIDstringRequiredExample: 4137e748-96ce-4354-94c6-8ebfbb48d756
Body
objectOptional
Responses
200

Fingerprint archived

application/json
Responseobject
post
/{mode}/v1/fingerprints/{fingerprintUUID}/archive

CloneFingerprint

post

Creates a copy of an existing fingerprint's settings but generates new session data. This allows you to duplicate a successful configuration while maintaining unique session identifiers.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
fingerprintUUIDstringRequiredExample: 73f990f2-23cc-41b0-b3ca-f65b385083f5
Body
objectOptional
Responses
200

Fingerprint cloned

application/json
Responseall of
post
/{mode}/v1/fingerprints/{fingerprintUUID}/clone

ResetFingerprint

post

Deletes all session data associated with the fingerprint while preserving its configuration. This allows you to start fresh with the same fingerprint settings.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
fingerprintUUIDstringRequiredExample: 420c1e83-69d7-4b6d-b07e-50dc0b2d7cd7
Body
objectOptional
Responses
200

Fingerprint reset

application/json
Responseobject
post
/{mode}/v1/fingerprints/{fingerprintUUID}/reset

UpdateFingerprintProxy

patch

Updates the proxy settings for a specific fingerprint. This allows you to change the geographic location and routing of browser traffic.

Authorizations
X-Api-KeystringRequired
X-Api-Key-IdstringRequired
Path parameters
modestringRequired
fingerprintUUIDstringRequiredExample: 420c1e83-69d7-4b6d-b07e-50dc0b2d7cd7
Body
countrystring ยท min: 2 ยท max: 2Required

Two-letter ISO country code for proxy location

Example: USPattern: ^[A-Z]{2}$
Responses
200

Proxy settings updated

application/json
Responseobject
patch
/{mode}/v1/fingerprints/{fingerprintUUID}/proxy

Last updated