Using Sentry Reserved Variables

Sentry reserved variables allow you to insert Sentry-generated information directly into your survey link or quality termination redirect. These variables are replaced automatically when a respondent exits Sentry, allowing you to capture Sentry outcomes, respondent details, language selection, and fraud signals inside your survey or reporting system.

This article explains:

What Sentry reserved variables are
Which variables are available
What each variable represents
How to use them in your survey links

What Are Sentry Reserved Variables?

Reserved variables are predefined placeholders that you can add directly to your Client Link or Termination Redirect Link within a Sentry project.

When a respondent finishes the Sentry screener:

Each reserved variable is replaced with its corresponding Sentry value
The respondent is redirected to your survey (or termination link) with those values populated

Reserved variables are:

Written in ALL CAPS
Case-sensitive
Only populated if they are explicitly included in the Client Link

Respondent and Provider Variables

SENTRY_RESPONDENT_ID
Replaced with the respondent ID received from the provider
SENTRY_PROVIDER_ID_VARIABLE_NAME
Replaced with the name of the provider’s respondent ID field

Language and Session Variables

SENTRY_SELECTED_LANGUAGE_CODE
Replaced with the language code selected by the respondent
SENTRY_SESSION_ID
Replaced with a unique identifier associated with the respondent’s Sentry session
SENTRY_PROJECT_ID
Replaced with the Sentry project ID for the respondent’s session

Location Variable

SENTRY_COUNTRY_CODE
Replaced with the respondent’s ISO country code based on IP location
Example values: US, GB, CA

Fraud and Quality Analysis Variables

Sentry provides additional variables that describe why a respondent was flagged. These are commonly used for advanced reporting, diagnostics, or audit workflows when allowing all Sentry respondents to enter the survey link.

Sentry Status

SENTRY_STATUS

Replaced with the respondent’s Sentry status value.

Possible numeric values:

1 – Passed Sentry
2 – Failed (Behavioral Interview)
3 – Failed (Technical / Security Blocked)

Primary Analysis Code

SENTRY_PRIMARY_ANALYSIS_CODE

Returns a numeric code representing the primary reason a respondent was flagged

Possible numeric values:

1 – Tech Blocked: Location Blocked
2 – Tech Blocked: Recaptcha
3 – Fraud: Bad Fingerprint
4 – Yea-saying
5 – Inattentive
6 – Duplicate IP Address
7 – Restricted Device
8 – Tech Blocked: Translation Detected
9 – Problematic Open End
10 – Lacking Domain Expertise
11 – Fraud: Bad Activity
30 – Verisoul Blocked
100 – Unknown or Unmapped Analysis

If the respondent passes all Sentry checks, this value will be empty.

All Analysis Flags

SENTRY_ANALYSIS_FLAGS_CODES
Returns a comma-separated list of all analysis codes triggered for the respondent

Uses the same numeric values as SENTRY_PRIMARY_ANALYSIS_CODE

Example output:

1,3,6

(Location Blocked, Bad Fingerprint, Duplicate IP)

Verisoul Variables (If Enabled)

If Verisoul is enabled within your organization, the following variables are available:

SENTRY_VERISOUL_DECISION
Replaced with Verisoul’s decision for the respondent
Possible numeric values:
- 0 – Real
- 1 – Suspicious
- 2 – Fake
SENTRY_VERISOUL_RISK_SIGNALS_SCORE
Replaced with Verisoul’s risk signals score for the respondent

Example: Using Reserved Variables in a Survey Link

If your Client Survey Link is configured as:

https://www.example.com/survey

The link with these variables added within Sentry: https://www.example.com?id=SENTRY_RESPONDENT_ID&status=SENTRY_STATUS&code=SENTRY_SELECTED_LANGUAGE_CODE

Note: When adding URL variables, the ? should always precede the first variable. Any additional variables should be added using &.

And the respondent’s values are:

Respondent ID: abc-123-xyz
Sentry status: 1
Language code: en

The respondent will be redirected to:

https://www.example.com/survey?id=abc-123-xyz&status=1&code=en

Dynamically Setting Respondent Language

If multiple languages are enabled on a Sentry project, respondents are normally asked to select a language at the start of the Sentry screener. You can control or skip this step using a query string parameter.

Note: The language must be enabled within the Sentry project for these parameters to function properly. A full list of available language codes can be found in the Supported Languages documentation.

Selecting a Single Language

To automatically select a language for a respondent, add the following parameter to the sample provider entry link:

preselectedLanguage

Example:

&preselectedLanguage=es

The respondent will immediately see the Sentry screener in Spanish, regardless of the number of languages enabled within the project setup.

Limiting Available Language Options

You may also provide a comma-separated list of language codes:

Examples:

&preselectedLanguage=en,es,fr

&preselectedLanguage=zh-CN,en

Behavior:

If only one listed language is available, it is automatically selected
If multiple listed languages are available, the respondent chooses
If none of the listed languages are available, all project languages are shown

Language codes are case-insensitive.

Dynamically Setting Respondent Location

When location verification is enabled on a Sentry project, respondents are validated based on IP location. You may specify the expected country using a query string parameter.

A full list of available country codes can be found in the ISO country code documentation.

Parameter: preselectedLocation

Value: Two-letter ISO country code (e.g., US, GB, CA)