Session Risk (Risk Score) Response Structure

Session Risk

This section provides the Arkose Risk Score and the associated telltales (or reason codes) that led to the risk score.

Field NameDescriptionValuesApplicable Product
session_riskAn object containing all risk score information and conclusions.Made up of the following subfields.

session_risk Subfields

Subfield Name Description Values Applicable Product

risk_category

Name of the risk category determined by the session's risk score.

One of "BOT-STD" (standard botnet), "BOT-ADV" (advanced botnet), "FRD-FRM" (fraud farm) or "CUSTOM" (custom category based on customer-defined telltales).

If both the Global and Custom Risk Scores are 0, session_risk's value will not have a risk_category field.

risk_band

Risk band category indicating risk severity as determined by risk scores.

One of "High", "Medium", or "Low"

global

Object containing the Global Risk Score value and the global telltales used to calculate it.

An array of objects consisting of score and telltales fields.

custom

Object containing the Custom Risk Score value and the global telltales used to calculate it.

An array of objects consisting of score and telltales fields.

global and custom Subfields

Subfield NameDescriptionValuesApplicable Product
scoreRisk 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".
telltalesTelltales 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

Name of a triggered telltale that contributed to calculating a Risk Score.

A string starting with g- to signify global, such as
"g-h-cfp-1000000000" or a string that does not start with g- meaning it is a custom telltale like "outdated-os-yandex"

weight

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 "1" and "100". Not "0" since a triggered telltale must have some weight.