Verify API Response Fields and Examples
Session Characteristics
These fields contain information about the session itself.
| Field Name | Description | Example Values | Applicable Component |
|---|---|---|---|
solved | When a session's risk level does not qualify it for transparent mode (no challenge) it is shown an interactive challenge. In that case, this field's value indicates if the challenge was successfully solved or not. If it was in transparent mode, the field value for a valid session is true. | true, false | Enforcement |
session | A unique token for the Arkose Labs session. A session is the whole experience from solution load to verification. | A unique token, e.g.3595d2c014d3c5f01.1116018803 | Detection Enforcement |
session_created | An ISO 8601 UTC timestamp signifying the time the session was created | e.g.2019-07-15T02:45:13+00:00,or null | Detection Enforcement |
check_answer | An ISO 8601 UTC timestamp signifying the time that the Enforcement Challenge user supplied answered were evaluated | e.g.2019-07-15T02:45:13+00:00,or null | Detection Enforcement |
verified | An ISO 8601 UTC timestamp signifying the time that the request to the verify endpoint was made. | e.g. ``2019-07-15T02:45:13+00:00 | Detection Enforcement |
attempted | Whether the user attempted to solve the Enforcement Challenge, or not. | true, false | Detection Enforcement |
security_level | A number that indicates the security level used for this session. Be aware that security_level can have a null value - usually because the session was an audio mode session. Audio mode does not use security_level. | A security level, e.g. 20 | Enforcement |
session_is_legit | Indicates if Arkose Labs certifies there are no telltales of non-legitimate activity in the session. | true, false | Detection Enforcement |
previously_verified | Indicates if a session has already been verified. | true, false | Detection Enforcement |
session_timed_out | Indicates if a session timed out before it was solved Note: The default timeout value / token lifespan is 30 minutes. | true, false | Detection Enforcement |
suppress_limited | Indicates if the session qualified for low security, but failed verification. Low security is when a session has qualified to run in transparent mode, or use a no wrong answer enforcement challenge, such as the pick your favorite color challenge. | true, false | Enforcement |
theme_arg_invalid | Whether the theme arg setting at verification matched the original theme arg passed in at session setup. A theme arg is a parameter passed by a customer to Arkose Labs. It requests a security tier or UX test mode. | true, false | Enforcement |
suppressed | Suppressed is the old name for transparent mode. This field shows if the the user was offered transparent mode. | true, false | Enforcement |
punishable_actioned | Punishable is an attack mitigation tactic, which randomly fails verification attempts, even if the response was correct. This field indicates if punishable was activated. | true, false | Enforcement |
telltale_user | UID for a combination of telltales that identify a particular bad user or organization. | A string such as 999b-fwh,or null | Detection Enforcement |
telltale_origin | Indicates the source configuration of a telltale_user. | A string such as 999b-fwh,or null | Detection Enforcement |
failed_low_sec_validation | Indicates that the intention was to offer the user a low security session, but they failed to qualify for it when the verification was attempted. | true, false | Enforcement |
lowsec_error | An identifier showing why a user was denied a low security session. | "user_credits", "rate_limit_local", "validation_checks", "rate_limit_global", or null | Detection Enforcement |
lowsec_level_denied | The low security level that was denied to the user. | A security level, e.g. 5 | Detection Enforcement |
ua | The User Agent string for the user that interacted with the EC. | "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.159 Safari/537.36“ | Detection Enforcement |
ip_rep_list | An identifier which specifies which IP reputation database this IP address has been seen at. | null | Detection Enforcement |
optional | An object containing optional return values such as client_encrypted_mode_key or get_pass values.Also, relevant data being sent to Arkose Labs via our accepted methods (see: Data Exchange (Requires Support login)) appears in this object. The specific keys and values inside this object vary based on implementation | {"blob": "lHpwagBqx3JOI7t9Ka0KUdIeHZbIjAYPPB72k Du2Zb5BwNiC6qJx5gS0f5c3EzcZ9d"}, or null | Detection Enforcement |
game_number_limit_reached | Game number limit is an optional setting that restricts the number of attempts a user can have at solving the EC. This field can show if the user reached the number of attempts allowed. | true, false | Enforcement |
user_language_shown | Shows the language code of the language in which the challenge was presented to the user. | A string such as “en“ or null | Enforcement |
telltale_list | The list of telltales that were identified as possible candidates during a session. | A string e.g. "999b-fwh", or null | Detection Enforcement |
challenge_type | The type of challenge that the end-user solved. | A string e.g. "audio", "transparent", "visual" or null | Detection Enforcement |
Fingerprint
The following sections (Browser Characteristics, Device Characteristics, User Preference, IP Intelligence) are fields containing information that identify the browser, device, etc. the session ran on.
Browser Characteristics
These fields contain information about the device the session ran on.
| Field Name | Description | Example Values | Applicable Component |
|---|---|---|---|
browser_name | The name of the browser the user was using. | A string, e.g. Chrome or null | Detection Enforcement |
browser_version | The version of the browser the user was using. | A version number, e.g. 92.0.4515.159 or null | Detection Enforcement |
color_depth | The color depth of the device used for the session. | A number, e.g. 24 or null | Detection Enforcement |
session_storage | Whether session storage was available or not. | true, false | Detection Enforcement |
indexed_database | Whether the browser uses any indexed database API. | true, false | Detection Enforcement |
canvas_fingerprint | The canvas fingerprint value of the browser. | e.g. 1652956012 or null | Detection Enforcement |
Device Characteristics
These fields contain information about the device the session ran on.
| Field Name | Description | Example Values | Applicable Product |
|---|---|---|---|
operating_system | The operating system used on the device. | e.g. Windows or null | Detection Enforcement |
operating_system_version | The version of the operating system used on the device. | e.g. XP or null | Detection Enforcement |
screen_resolution | The current screen resolution of the device. | e.g. [1920,1080] or null | Detection Enforcement |
max_resolution_supported | The maximum supported screen resolution of the device. | e.g. [1920,1080] or null | Detection Enforcement |
behavior | Whether the device / browser supports the addBehavior method. Note that addBehavior is considered obsolete with Windows 10. | true, false | Detection Enforcement |
cpu_class | The CPU class identifier of the device. | e.g. X86 or null | Detection Enforcement |
platform | The platform the device belongs to. | e.g. MacIntel or null | Detection Enforcement |
touch_support | Whether the device has touch support or not. | true, false | Detection Enforcement |
hardware_concurrency | The hardware concurrency support of the device. | e.g. 8 or null | Detection Enforcement |
User Preference Field
This field contains information about the session set by its user.
| Field Name | Description | Example Values | Applicable Product |
|---|---|---|---|
timezone_offset | The timezone offset from UTC. | e.g. 1000 or null | Detection Enforcement |
IP Intelligence Fields
These fields contain information related to and derived from the IP address associated with the session.
| Field Name | Description | Example Values | Applicable Product |
|---|---|---|---|
timezone | The timezone the session was originated from. | A string, e.g.America/Los_Angeles or null | Detection Enforcement |
user_ip | The IP address of the device used for the session. | An IP address, e.g.199.220.42.206, or null | Detection Enforcement |
is_tor | Indicates if the IP is suspected of being a TOR connection (either active or previously hosted TOR nodes and exist). | true, false | Detection Enforcement |
is_vpn | Indicates if the IP is suspected of being a VPN connection. For example, it has been on a VPN and can include data center ranges. | true, false | Detection Enforcement |
is_proxy | Indicates if this IP address suspected to be a proxy. | true, false | Detection Enforcement |
is_bot[Soon to be deprecated, for more information please visit is_bot Field End of Life Communication] | Whether the session is bot-originated or not. | true, false | Detection Enforcement |
country | Country the User IP belongs to. | A string, e.g. US or null. | Detection Enforcement |
region | State/Region that the IP belongs to. | A string, e.g. California or null. | Detection Enforcement |
city | The city the IP belongs to. | A string, e.g. Fremont or null | Detection Enforcement |
isp | The Internet Service Provider name. | A string, e.g. AT&T U-verse or null | Detection Enforcement |
public_access_point | Whether the IP address belongs to education and research institutions, corporates, or public WiFi such as hotel lobby, coffee shop, etc. | true, false | Detection Enforcement |
connection_type | Whether the connection type belongs to one of the following categories: Residential, Corporate, Education, Mobile, Data Center | A string, e.g. Residential or nullNote: The value 0 represents unknown. Not many IP addresses return this value, and the correct value for these IPs typically updates the next scan. If a trend is occurring, it could be due to the subnet is in the process of being transitioned. | Detection Enforcement |
latitude | The latitude coordinates of the device used for the session. | e.g. 37.52809906 or null | Detection Enforcement |
longitude | The longitude coordinates of the device used for the session. | e.g. -121.97319794 or null | Detection Enforcement |
Session Risk Field
This field contains risk score related to the session derived by triggered telltales.
| Field Name | Description | Example Values | Applicable Component |
|---|---|---|---|
risk_category | The type of threat detected on a session (standard bot, advanced bot, fraud farm, custom) | A string e.g. BOT-STD or BOT-ADV or FRD-FRM or CUSTOM | Detection Enforcement |
risk_band | The classification of a session as low / medium / high risk based on the Max value from the custom and global risk scores. | A string e.g. LOW or MEDIUM or HIGH | Detection Enforcement |
global | This field object contains 2 subfields score & telltales.score - A value between 0 and 100 representing the risk associated with teh session based on the global telltales that triggered on a session.telltales - List of global telltales triggered with 2 subfields name & weight. | An object e.g.{ "score":10, "telltales": [{ "name":"g-reputation-recent-abuse-proxy", "weight":10 }] } | Detection Enforcement |
custom | This field object contains 2 subfields score & telltales.score- A value between 0 and 100 representing the risk associated with teh session based on the customer telltales that triggered on a session.telltales - List of custom telltales triggered with 2 subfields name & weight. | An object e.g.{ "score": "100", "telltales":[ { "name": "outdated-browser-yandex-2", "weight": "7" }] } | Detection Enforcement |
Sample Verify API Responses
The following examples show different Verify API responses. They show the typical values in each field for each type of response.
{
"session_details": {
"solved": true,
"session": "43217b823752a4848.1388061501",
"session_created": "2024-02-28T21:17:26Z",
"check_answer": "2024-02-28T21:17:36Z",
"verified": "2024-02-28T21:17:47Z",
"attempted": true,
"security_level": 20,
"session_is_legit": true,
"previously_verified": false,
"session_timed_out": false,
"suppress_limited": false,
"theme_arg_invalid": false,
"suppressed": false,
"punishable_actioned": false,
"telltale_user": "g-reputation-hosting",
"telltale_origin":"example-telltale-e-app",
"failed_low_sec_validation": false,
"lowsec_error": null,
"lowsec_level_denied": null,
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"ip_rep_list": null,
"optional": null,
"game_number_limit_reached": false,
"user_language_shown": "en",
"telltale_list": [
"g-reputation-hosting",
"g-reputation-vpn"
],
"challenge_type": "visual"
},
"fingerprint": {
"browser_characteristics": {
"browser_name": "Chrome",
"browser_version": "120.0.0.0",
"color_depth": 24,
"session_storage": true,
"indexed_database": true,
"canvas_fingerprint": 1131944312
},
"device_characteristics": {
"operating_system": "OS X",
"operating_system_version": "10.15.7",
"screen_resolution": [
1920,
1080
],
"max_resolution_supported": [
1920,
1055
],
"behavior": false,
"cpu_class": "unknown",
"platform": "MacIntel",
"touch_support": false,
"hardware_concurrency": 8
},
"user_preferences": {
"timezone_offset": 360
}
},
"ip_intelligence": {
"user_ip": "18.190.53.157",
"is_tor": false,
"is_vpn": true,
"is_proxy": true,
"is_bot": false,
"country": "US",
"region": "Ohio",
"city": "Columbus",
"isp": "Amazon.com",
"public_access_point": false,
"connection_type": "Data Center",
"latitude": "39.9587",
"longitude": "-82.9987",
"timezone": "America/New_York"
},
"session_risk": {
"risk_category": "BOT-STD",
"risk_band": "Low",
"global": {
"score": 36,
"telltales": [
{
"name": "g-reputation-hosting",
"weight": 20
},
{
"name": "g-reputation-vpn",
"weight": 20
}
]
},
"custom": {
"score": 0,
"telltales": []
}
},
"aggregations": {
"ip": {
"short_term": {
"interval_minutes": 60,
"count": 2,
"threshold": 360
},
"long_term": {
"interval_minutes": 1440,
"count": 2,
"threshold": 100
}
}
},
"data_exchange": {
"blob_decrypted": null,
"blob_received": null
}
}
{
"session_details": {
"solved": false,
"session": "43217b82394172236.2145822401",
"session_created": "2024-02-28T21:19:41Z",
"check_answer": null,
"verified": "2024-02-28T21:20:22Z",
"attempted": false,
"security_level": 30,
"session_is_legit": true,
"previously_verified": false,
"session_timed_out": false,
"suppress_limited": false,
"theme_arg_invalid": false,
"suppressed": false,
"punishable_actioned": false,
"telltale_user": "g-reputation-hosting",
"telltale_origin":"example-telltale-e-app",
"failed_low_sec_validation": false,
"lowsec_error": null,
"lowsec_level_denied": null,
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"ip_rep_list": null,
"optional": null,
"game_number_limit_reached": true,
"user_language_shown": "en",
"telltale_list": [
"g-reputation-hosting",
"g-reputation-vpn"
],
"challenge_type": null
},
"fingerprint": {
"browser_characteristics": {
"browser_name": "Chrome",
"browser_version": "120.0.0.0",
"color_depth": 24,
"session_storage": true,
"indexed_database": true,
"canvas_fingerprint": 1131944312
},
"device_characteristics": {
"operating_system": "OS X",
"operating_system_version": "10.15.7",
"screen_resolution": [
1920,
1080
],
"max_resolution_supported": [
1920,
1055
],
"behavior": false,
"cpu_class": "unknown",
"platform": "MacIntel",
"touch_support": false,
"hardware_concurrency": 8
},
"user_preferences": {
"timezone_offset": 360
}
},
"ip_intelligence": {
"user_ip": "18.190.53.157",
"is_tor": false,
"is_vpn": true,
"is_proxy": true,
"is_bot": false,
"country": "US",
"region": "Ohio",
"city": "Columbus",
"isp": "Amazon.com",
"public_access_point": false,
"connection_type": "Data Center",
"latitude": "39.9587",
"longitude": "-82.9987",
"timezone": "America/New_York"
},
"session_risk": {
"risk_category": "BOT-STD",
"risk_band": "Low",
"global": {
"score": 36,
"telltales": [
{
"name": "g-reputation-hosting",
"weight": 20
},
{
"name": "g-reputation-vpn",
"weight": 20
}
]
},
"custom": {
"score": 0,
"telltales": []
}
},
"aggregations": {
"ip": {
"short_term": {
"interval_minutes": 60,
"count": 3,
"threshold": 360
},
"long_term": {
"interval_minutes": 1440,
"count": 3,
"threshold": 100
}
}
},
"data_exchange": {
"blob_decrypted": null,
"blob_received": null
}
}
{
"error": "DENIED ACCESS",
"verified": "2021-08-30T22:15:00+00:00"
}
{
"session_details": {
"solved": true,
"session": "75517b8243b6f0441.7468814901",
"session_created": "2024-02-28T21:31:39Z",
"check_answer": "2024-02-28T21:32:11Z",
"verified": "2024-02-28T21:32:21Z",
"attempted": true,
"security_level": 50,
"session_is_legit": true,
"previously_verified": false,
"session_timed_out": false,
"suppress_limited": false,
"theme_arg_invalid": false,
"suppressed": false,
"punishable_actioned": false,
"telltale_user": "g-reputation-hosting",
"telltale_origin":"example-telltale-e-app",
"failed_low_sec_validation": false,
"lowsec_error": "user_credits",
"lowsec_level_denied": null,
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"ip_rep_list": null,
"optional": null,
"game_number_limit_reached": false,
"user_language_shown": "en",
"telltale_list": [
"g-reputation-hosting",
"g-reputation-vpn"
],
"challenge_type": "visual"
},
"fingerprint": {
"browser_characteristics": {
"browser_name": "Chrome",
"browser_version": "120.0.0.0",
"color_depth": 24,
"session_storage": true,
"indexed_database": true,
"canvas_fingerprint": 1131944312
},
"device_characteristics": {
"operating_system": "OS X",
"operating_system_version": "10.15.7",
"screen_resolution": [
1920,
1080
],
"max_resolution_supported": [
1920,
1055
],
"behavior": false,
"cpu_class": "unknown",
"platform": "MacIntel",
"touch_support": false,
"hardware_concurrency": 8
},
"user_preferences": {
"timezone_offset": 360
}
},
"ip_intelligence": {
"user_ip": "18.190.53.157",
"is_tor": false,
"is_vpn": true,
"is_proxy": true,
"is_bot": false,
"country": "US",
"region": "Ohio",
"city": "Columbus",
"isp": "Amazon.com",
"public_access_point": false,
"connection_type": "Data Center",
"latitude": "39.9587",
"longitude": "-82.9987",
"timezone": "America/New_York"
},
"session_risk": {
"risk_category": "BOT-STD",
"risk_band": "Low",
"global": {
"score": 36,
"telltales": [
{
"name": "g-reputation-hosting",
"weight": 20
},
{
"name": "g-reputation-vpn",
"weight": 20
}
]
},
"custom": {
"score": 0,
"telltales": []
}
},
"aggregations": {
"ip": {
"short_term": {
"interval_minutes": 60,
"count": 5,
"threshold": 360
},
"long_term": {
"interval_minutes": 1440,
"count": 5,
"threshold": 100
}
}
},
"data_exchange": {
"blob_decrypted": null,
"blob_received": null
}
}
{
"session_details": {
"solved": false,
"session": "43217b82394172236.2145822401",
"session_created": "2024-02-28T21:19:41Z",
"check_answer": null,
"verified": "2024-02-28T21:20:22Z",
"attempted": false,
"security_level": 30,
"session_is_legit": true,
"previously_verified": false,
"session_timed_out": false,
"suppress_limited": false,
"theme_arg_invalid": false,
"suppressed": false,
"punishable_actioned": false,
"telltale_user": "g-reputation-hosting",
"telltale_origin":"example-telltale-e-app",
"failed_low_sec_validation": false,
"lowsec_error": null,
"lowsec_level_denied": null,
"ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36",
"ip_rep_list": null,
"optional": {
"blob": "BbfYFeKzwEwnGCAU.fCWy85IOHQ2j2SomSW6bf6Mibfgdlqn7MWyoY8JbYkVskPsLbqBqryeAR0EVC1pi5XosVJjPfvWZ4H6EBQgC5XYnHVeKwQ=="
},
"game_number_limit_reached": true,
"user_language_shown": "en",
"device_id": "null",
"telltale_list": [
"g-reputation-hosting",
"g-reputation-vpn"
],
"challenge_type": null
},
"fingerprint": {
"browser_characteristics": {
"browser_name": "Chrome",
"browser_version": "120.0.0.0",
"color_depth": 24,
"session_storage": true,
"indexed_database": true,
"canvas_fingerprint": 1131944312
},
"device_characteristics": {
"operating_system": "OS X",
"operating_system_version": "10.15.7",
"screen_resolution": [
1920,
1080
],
"max_resolution_supported": [
1920,
1055
],
"behavior": false,
"cpu_class": "unknown",
"platform": "MacIntel",
"touch_support": false,
"hardware_concurrency": 8
},
"user_preferences": {
"timezone_offset": 360
}
},
"ip_intelligence": {
"user_ip": "18.190.53.157",
"is_tor": false,
"is_vpn": true,
"is_proxy": true,
"is_bot": false,
"country": "US",
"region": "Ohio",
"city": "Columbus",
"isp": "Amazon.com",
"public_access_point": false,
"connection_type": "Data Center",
"latitude": "39.9587",
"longitude": "-82.9987",
"timezone": "America/New_York"
},
"session_risk": {
"risk_category": "BOT-STD",
"risk_band": "Low",
"global": {
"score": 36,
"telltales": [
{
"name": "g-reputation-hosting",
"weight": 20
},
{
"name": "g-reputation-vpn",
"weight": 20
}
]
},
"custom": {
"score": 0,
"telltales": []
}
},
"aggregations": {
"ip": {
"short_term": {
"interval_minutes": 60,
"count": 3,
"threshold": 360
},
"long_term": {
"interval_minutes": 1440,
"count": 3,
"threshold": 100
}
}
},
"data_exchange": {
"blob_decrypted": null,
"blob_received": null
}
}
Data Exchange
Data Exchange Response Structure
To view the full Data Exchange Response Structure please visit Data Exchange: Enhanced Detection and API Source Validation (needs Zendesk authentication).
Email Intelligence
Email Intelligence Response Structure
To view the full Email Intelligence Response Structure please visit Email Intelligence API Reference (needs Zendesk authentication).
Device ID
Device ID Response Structure
To view the full Device ID Response Structure please visit Stateless Device ID and Stateful Device ID (needs Zendesk authentication).
Updated 10 days ago