Basic Response Structure
Session Details
This section constitutes the basic session level details such as challenge details, pressure levels, whether the attacker surpassed basic defenses, etc.
| Field Name | Description | Example Values | Applicable Product |
|---|---|---|---|
|
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 |
|
Arkose Protect |
|
A unique token for the Arkose Labs session. A session is the whole experience from solution load to verification. |
A unique token, e.g. |
Arkose Detect |
|
An ISO 8601 UTC timestamp signifying the time the session was created |
e.g. |
Arkose Detect |
|
An ISO 8601 UTC timestamp signifying the time that the Enforcement Challenge user supplied answered were evaluated |
e.g. |
Arkose Protect |
|
An ISO 8601 UTC timestamp signifying the time that the request to the verify endpoint was made. |
e.g. |
Arkose Detect |
|
Whether the user attempted to solve the Enforcement Challenge, or not. |
|
Arkose Protect |
|
A number that indicates the security level used for this session. Be aware that |
A security level, e.g. |
Arkose Protect |
|
Indicates if Arkose Labs certifies there are no telltales of non-legitimate activity in the session. |
|
Arkose Detect |
|
Indicates if a session has already been verified |
|
Arkose Detect |
|
Indicates if a session timed out before it was solved |
|
Arkose Detect |
|
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. |
|
Arkose Protect |
|
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. |
|
Arkose Protect |
|
Suppressed is the old name for transparent mode. This field shows if the the user was offered transparent mode. |
|
Arkose Protect |
|
Punishable is an attack mitigation tactic, which randomly fails verification attempts, even if the response was correct. This field indicates if punishable was activated. |
|
Arkose Protect |
|
UID for a combination of telltales that identify a particular bad user or organization. |
A string such as |
Arkose Detect |
|
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. |
|
Arkose Protect |
|
An identifier showing why a user was denied a low security session. |
|
Arkose Detect |
|
The low security level that was denied to the user. |
A security level, e.g. |
Arkose Detect |
|
The User Agent string for the user that interacted with the EC. |
|
Arkose Detect |
|
An identifier which specifies which IP reputation database this IP address has been seen at. |
|
Arkose Detect |
|
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 |
|
Arkose Detect |
|
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. |
|
Arkose Protect |
|
Shows the language code of the language in which the challenge was presented to the user. |
A string such as |
Arkose Protect |
|
The list of telltales that were identified as possible candidates during a session. |
A string e.g. |
Arkose Detect |
|
Note: You must request that Arkose turn on |
A |
|
|
The type of challenge that the end-user solved. |
A string e.g. |
Arkose Detect |
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. |
Arkose Detect |
Session Risk
This section provides the Arkose Risk Score and the associated telltales (or reason codes) that led to the risk score.
| Field Name | Description | Values | Applicable Product |
|---|---|---|---|
session_risk | An object containing all risk score information and conclusions. | Made up of the following subfields. |
session_risk Subfields
| Subfield Name | Description | Values | Applicable Product |
|---|---|---|---|
|
Name of the risk category determined by the session's risk score. |
One of If both the Global and Custom Risk Scores are |
|
|
Risk band category indicating risk severity as determined by risk scores. |
One of |
|
|
Object containing the Global Risk Score value and the global telltales used to calculate it. |
An array of objects consisting of |
|
|
Object containing the Custom Risk Score value and the global telltales used to calculate it. |
An array of objects consisting of |
global and custom Subfields
| Subfield Name | Description | Values | Applicable Product |
|---|---|---|---|
score | Risk Score value. If under global, the Global Risk Score. If under custom, the Custom Risk Score. | A string of an integer between 0 and 100, such as "87". If under custom, it will be either "0" or "100". | |
telltales | Telltales that contributed to calculating a Risk Score. If under global, the Global Risk Score. If under custom, the Custom Risk Score. | An array of objects consisting of name andweight fields. |
telltales Subfields
| Subfield Name | Description | Values | Applicable Product |
|---|---|---|---|
|
Name of a triggered telltale that contributed to calculating a Risk Score. |
A string starting with |
|
|
The weight given this triggered telltale when calculating a Risk Score. Note that a telltale’s weight is not necessarily the same as the eventual total score. |
A string of an integer between |
Data Exchange
Data Exchange Response StructureTo view the full Email Intelligence Response Structure please visit **Data Exchange: Enhanced Detection and API Source Validation **(needs Zendesk authentication).
Updated 5 days ago