Verify API Response Fields and Examples
Session Characteristics
These fields contain information about the session itself.
Field Name | Description | Example Values | Applicable Component |
|---|---|---|---|
| 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 |
| Enforcement |
| A unique token for the Arkose Labs session. A session is the whole experience from solution load to verification. | A unique token, e.g. | Detection |
| An ISO 8601 UTC timestamp signifying the time the session was created | e.g. | Detection |
| An ISO 8601 UTC timestamp signifying the time that the Enforcement Challenge user supplied answered were evaluated | e.g. | Detection |
| An ISO 8601 UTC timestamp signifying the time that the request to the verify endpoint was made. | e.g. | Detection |
| Whether the user attempted to solve the Enforcement Challenge, or not. |
| Detection |
| A number that indicates the security level used for this session. Be aware that | A security level, e.g. | Enforcement |
| Indicates if Arkose Labs certifies there are no telltales of non-legitimate activity in the session. |
| Detection |
| Indicates if a session has already been verified. |
| Detection |
| Indicates if a session timed out before it was solved
|
| Detection |
| 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. |
| Enforcement |
| 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. |
| Enforcement |
| Suppressed is the old name for transparent mode. This field shows if the the user was offered transparent mode. |
| Enforcement |
| Punishable is an attack mitigation tactic, which randomly fails verification attempts, even if the response was correct. This field indicates if punishable was activated. |
| Enforcement |
| UID for a combination of telltales that identify a particular bad user or organization. | A string such as | Detection |
| Indicates the source configuration of a | A string such as | Detection |
| 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. |
| Enforcement |
| An identifier showing why a user was denied a low security session. |
| Detection |
| The low security level that was denied to the user. | A security level, e.g. | Detection |
| The User Agent string for the user that interacted with the EC. | | Detection |
| An identifier which specifies which IP reputation database this IP address has been seen at. |
| Detection |
| An object containing optional return values such as 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 | , or null | Detection |
| 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. |
| Enforcement |
| Shows the language code of the language in which the challenge was presented to the user. | A string such as | Enforcement |
| The list of telltales that were identified as possible candidates during a session. | A string e.g. | Detection |
| The type of challenge that the end-user solved. | A string e.g. | Detection |
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 |
|---|---|---|---|
| The name of the browser the user was using. | A string, e.g. | Detection Enforcement |
| The version of the browser the user was using. | A version number, e.g. | Detection Enforcement |
| The color depth of the device used for the session. | A number, e.g. | Detection Enforcement |
| Whether session storage was available or not. |
| Detection Enforcement |
| Whether the browser uses any indexed database API. |
| Detection Enforcement |
| The canvas fingerprint value of the browser. | e.g. | Detection Enforcement |
Device Characteristics
These fields contain information about the device the session ran on.
Field Name | Description | Example Values | Applicable Product |
|---|---|---|---|
| The operating system used on the device. | e.g. | Detection Enforcement |
| The version of the operating system used on the device. | e.g. | Detection Enforcement |
| The current screen resolution of the device. | e.g. | Detection Enforcement |
| The maximum supported screen resolution of the device. | e.g. | Detection Enforcement |
| Whether the device / browser supports the |
| Detection Enforcement |
| The CPU class identifier of the device. | e.g. | Detection Enforcement |
| The platform the device belongs to. | e.g. | Detection Enforcement |
| Whether the device has touch support or not. |
| Detection Enforcement |
| The hardware concurrency support of the device. | e.g. | Detection Enforcement |
User Preference Field
This field contains information about the session set by its user.
Field Name | Description | Example Values | Applicable Product |
|---|---|---|---|
| The timezone offset from UTC. | e.g. | 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 |
|---|---|---|---|
| The timezone the session was originated from. | A string, e.g.
| Detection Enforcement |
| The IP address of the device used for the session. | An IP address, e.g.
| Detection Enforcement |
| Indicates if the IP is suspected of being a TOR connection (either active or previously hosted TOR nodes and exist). |
| Detection Enforcement |
| 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. |
| Detection Enforcement |
| Indicates if this IP address suspected to be a proxy. |
| Detection Enforcement |
| Country the User IP belongs to. | A string, e.g. | Detection Enforcement |
| State/Region that the IP belongs to. | A string, e.g. | Detection Enforcement |
| The city the IP belongs to. | A string, e.g. | Detection Enforcement |
| The Internet Service Provider name. | A string, e.g. | Detection Enforcement |
| Whether the IP address belongs to education and research institutions, corporates, or public WiFi such as hotel lobby, coffee shop, etc. |
| Detection Enforcement |
| Whether the connection type belongs to one of the following categories: Residential, Corporate, Education, Mobile, Data Center | A string, e.g. Note:
The value | Detection |
| The latitude coordinates of the device used for the session. | e.g. | Detection |
| The longitude coordinates of the device used for the session. | e.g. | Detection |
| Autonomous System Number (ASN) | A int e.g. | Detection |
| Estimated effective round-trip time of the current connection | A int e.g. | Detection |
Session Risk Field
This field contains risk score related to the session derived by triggered telltales.
Field Name | Description | Example Values | Applicable Component |
|---|---|---|---|
| The type of threat detected on a session (standard bot, advanced bot, fraud farm, custom) | A string e.g. | Detection Enforcement |
| 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. | Detection Enforcement |
| This field object contains 2 subfields
| An object e.g. | Detection |
| This field object contains 2 subfields
| An object e.g. | Detection |
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,
"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",
"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,
"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,
"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,
"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",
"asn": "14618",
"network_info_rtt": "50"
},
"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).
Proof of Work
Proof of Work Response Structure
To view the full Proof of Work Response Structure please visit Proof of Work (Beta Preview) (needs Zendesk authentication).
Updated about 19 hours ago