v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Identify user by fingerprint

Identifies a user based on request fingerprint (IP address, User-Agent, and optional device data). Headers (or query params for screen_size and timezone) improve matching when multiple users share an IP.

get/user/identify

Query parameters

screen_sizestring

Device screen size for fingerprint matching.

Example:440x956

timezonestring

Client timezone for fingerprint matching.

Example:UTC+03:00

os_versionstring

OS version for enhanced fingerprint matching.

Example:iOS 18.3.2

Headers

api_keystring required

API key for authentication.

Example:w2w_test_api_key_12345

User-Agentstring required

Client user agent used for fingerprint matching.

Example:Mozilla/5.0 (iPhone; CPU iPhone OS 18_3_2 like Mac OS X) AppleWebKit/605.1.15

platformstring

Device/platform for fingerprint matching (e.g. ios, android, web).

Example:iOS

screen_sizestring

Device screen size for fingerprint matching. May also be sent as query param.

Example:440x956

timezonestring

Client timezone for fingerprint matching. May also be sent as query param.

Example:UTC+03:00

os_versionstring

OS version for enhanced fingerprint matching. May also be sent as query param.

Example:iOS 18.3.2

Response

Identification result (user found or not).

success0 | 1

1 if a user was identified, 0 otherwise.

user_idstring nullable

Identified user GUID, or null if no match.

match_methodstring

How the user was matched (e.g. IP, fingerprint).

platformstring nullable

Detected or provided platform.

messagestring

Present when success is 0 (e.g. "User not found by fingerprint").

errorinteger

Present on failure (1).

error_msgstring

Error message when error is 1 (e.g. missing IP/User-Agent).