1. Overview
This guide presents the requirements for implementing the links for Realeyes Verify service to direct users through the Verify Entry Link, into the VerifySite for facial verification and quality checks, and onto the Survey Entry Link.
The following diagram illustrates the redirect chain
2. Setting up Verify
When setting up Verify before a survey, you need to redirect the respondents' traffic to the Verify Entry link. Our service runs in three regions (EU, USA and Singapure) to meet the highest levels of security, compliance, and data protection. The Verify Entry link follows these structures depending on the region choice:
EU URL:
https://verify.realeyesit.com/landing?region=eu&accountHash=ACCOUNTHASH&targetUrl=URL_ENCODED_TARGET_URL&collectionName=COLLECTION
USA URL:
https://verify.realeyesit.com/landing?region=us&accountHash=ACCOUNTHASH&targetUrl=URL_ENCODED_TARGET_URL&collectionName=COLLECTION
SG URL:
https://verify.realeyesit.com/landing?region=sg&accountHash=ACCOUNTHASH&targetUrl=URL_ENCODED_TARGET_URL&collectionName=COLLECTION
The ACCOUNTHASH is the account hash assigned to account on the Developers Portal. This is the unique username to authenticate and secure access to the Verify service.
3. Redirecting to the desired survey
Verify provides two working modes:
- Monitoring respondents: Verify monitors every respondent without taking any action. All users pass through to the target URL, regardless of giving consent or passing verification. The verification status is recorded.
- Qualifying respondents: Verify verification status is set as a qualifying condition, so if a respondent fails verification or does not give consent, they will proceed to the termination page supplied as the return URL. All verified respondents pass through to the target URL.
After the respondent is finished with the facial verification, the Verify service will redirect them back. The recorded respondent status will be monitored continuously and can be tracked on the provided dashboard. If you have any questions or need dashboard access, please write to verify@realeyesit.com
3.1 Monitoring: Allowing every respondent into the survey
Please, append your URL encoded Survey Entry Link without appended variables in the targetURL
variable. For more details about how to pass custom variables, see section 7.
Verify will redirect all respondents to the survey after the facial verification. The respondent continues on to the survey despite the verification status (section 9)
Tip
will redirect to https://verify-demo.realeyesit.com
3.2 Qualifying: Allowing only verified users into the survey
After the respondent is finished taking the verification, you can set up Verify to
- Redirect verified respondents to the survey by appending your URL encoded Survey Entry Link
without appended variables in the
targetURL
variable. - Reject respondents that fail to verify or who do not give consent by appending your URL
encoded Terminate Link in the
returnURL
variable. Terminate Link is url that redirects to the end of the survey with termination or passes back with termination.
Tip
will redirect verified users to the survey at https://verify-demo.realeyesit.com
and unverified users back to https://yourplatform.com/terminate
4. Selecting the collection of features - Mandatory
For each face detected, we extract facial features and store the feature information in a database which we call a collection.
The collection name must be specified in the variable collectionName
as Verify searches new faces
against all faces in the specified collection to detect duplicate or fraudulent attempts.
Tip
You set up a survey and redirect participants to the Verify via this link:
All data collected per session is stored in the collection ATest.
If the same collection name is used for multiple surveys, the facial verification will detect as duplicate attempts those participants who already completed one of the surveys. This can be useful for monitoring duplicate attempts of respondents that have participated in previous surveys
Tip
You set up two surveys for an A/B test: https://yoursurvey.com/surveyA and https://yoursurvey.com/surveyB
And respondents from survey A are excluded from survey B, and viceversa.
For verifying the uniqueness of respondents, both Verify entry links will pass the same collectionName &collectionName=ABTes
The service is currently isolated by region, so the same collection name will be a different collection for the EU, US and SG VerifyEntry Links.
5. Unique ID per session - Recommended
To provide better data, we recommend passing the GUID (Globally Unique Identifier) for each survey
transaction in the userSessionId
variable. This can be the unique id per session required for recording
the survey outcomes and will serve for matching purposes when analysing the results.
If the Survey entry link needs the GUID, just append the variable to the targetURL with your desired
keyname and the value {userId}
. The Verify service will substitute the originally received GUID into this
variable.
Tip
will redirect to https://verify-demo.realeyesit.com?user_id=GUID
In case this GUID is not passed as a variable, our service will create a unique session ID and time stamp which will be shown to the participant and in the monitoring dashboard (see section 3 for more information on the Dashboard).
6. Multiple panel providers - Recommended
In projects involving participants from various panel providers, it is advisable to distinguish the panels by incorporating the variable panelProvider within the Verify entry link. This practice is recommended to enhance the clarity of panel source identification.
Tip
The project will be launched in two different panels: panel A and panel B.
The Verify entry link on panel A will be set to: https://verify.realeyesit.com/landing?region=eu&accountHash=ACCOUNTHASH&targetUrl=https%3A%2F%2Fverify-demo.realeyesit.com%26userId%3D%7BuserId%7D&collectionName=ATest&userSessionId=GUID&panelProvider=A
And the one on panel B to: https://verify.realeyesit.com/landing?region=eu&accountHash=ACCOUNTHASH&targetUrl=https%3A%2F%2Fverify-demo.realeyesit.com%26userId%3D%7BuserId%7D&collectionName=ATest&userSessionId=GUID&panelProvider=B
Since both Verify links use the same collection name, when searching for new faces, all faces within the collection will be included in the process, regardless of their source provider
7. Passing Variables into Survey
For a full experience of the Verify service, we recommend passing age and gender using the variables
age
and gender
which allows for the confirmation of the demographic data by Vision AI. The
expected values for gender are male
or female
.
Tip
The Verify entry link will be set to:
Our platform can pass through any variable in the entry link. Below you'll find an example of the structure to append variables to your Verify Entry Link.
Tip
In this example,. the Panel provider captured answers to common demographic questions (age, gender, race, employment) and appended the following results within the Verify Entry Link
&age=37&gender=male&Race=12&Employment=55
The Survey Entry Link (https://verify-demo.realeyesit.com) then becomes:
https://verify-demo.realeyesit.com?user_id=GUID&age=37&gender=male&Race=12&Employment=55
8. Setting a different language from English
English is the default language for Verify. The UI language can be configured using the lang
parameter appended to the entry URL.
The available languages include:
Language | Key&value |
---|---|
French | lang=fr |
German | lang=de |
Spanish | lang=es |
Italian | lang=it |
Traditional Chinese | lang=zh-hant |
Simplified Chinese | lang=zh-hans |
Tip
In this example,. the desired language is Spanish. So the lang variable was appended within the Verify Entry Link
Realeyes can incorporate any translations you provide for the consent dialogue and/or UI messages. Please send your request to verify@realeyesit.com
9. Verification status
The verification status will be appended into the targetURL
as an addiitional parameter named
verificationStatus
, follwing this syntax:
- OK - New verified account in the collection
- Duplicate - Duplicate account found in the collection
- NotEligible - Consent denied, or suspected fraud
- Null - Session terminated by user leaving the site
This status does not currently trigger any actions or decisions in Verify for how to proceed with a panelist.
Tip
In this example, Verify returned a NotEligible value. The Survey Entry Link (https://verify-demo.realeyesit.com) will become:
10. Auditing Verifications via API
Verify includes an API that can integrate with your application to audit verifications. We provide an API where you can check and verify that the session has been indeed verified on RealEyes. See the API documentation for more information.