Survey Entry Url

Our Survey entry url provides various capability for our suppliers to pass different type of information along with respondent. The survey entry url will be provided for each survey in Surveys api call.

Survey entry url parameters

example survey entry link

https://rf-sandbox.voqall.com/l?vq_sid=&vq_vid=&vq_token=TXN123456&vq_uid=USER789&email_hash=abc123

Survey entry url parameters :

Param Name	Required	Description
vq_sid	Yes	Unique survey id, this is auto filled in entry link
vq_vid	Yes	Supplier id,this is auto filled in entry link
vq_token	Yes	Unique transaction/respondent token generated per session by supplier
vq_uid	Yes	Respondent unique User ID on your supplier's system

Addtional parameters

We support accepting addtional parameters which will help us to give you better survey inventory.

Email Hash

Suppliers may optionally ( recommended to be eligible for more surveys) pass respondent hashed email in survey entry url.

Email Hash Generation

var email_hash = SHA256(lower(respondent_email))

var urlWithEmailHash= https://rf-sandbox.voqall.com/l?...&email_hash={hashed_email_value}

Do not pass raw email address in the query string parameters

Demographics

You may optionally pass demographic information in the redirect URL to enable auto-punching. This will allow us to improve respondent experience. We will not re-ask the questions which we have already recieved in entry url.

Supported Auto-Punch Parameters

age

gender (answer ID/code)

zip

**Q**{StandardQualID}=answerId1,answerId2

Example query params

... &age=32&gender=2&zip=90210&Q20=1,3

Redirect/Postback Urls

Redirect Type	Required	Description
Complete	Yes	Postback url to be used when respondent has completed the survey
Terminate	Yes	Postback url to be used when respondent is not qualified
Overquota	Yes	Postback url to be used when the requierd quota is met
Security Terminate	Yes	Postback url if the respondent fails security checks

Postback Variables
We support below variables which can used in redirect url to be returned back to suppliers.

Variable	Description
[%%token%%]	Supplier Token
[%%vendor_user_id%%]	Supplier User Id
[%%status_id%%]	Respondent Status Id

Postback url encryption
Browser Redirects Only

To secure your postback redirect urls,we will provide encryption key. Suppliers can choose to pick from SHA1 or SHA256 ( recommended ) encryption algorithms.

The encrypted url hash value will be appened in the postback url as below

Url encryption example

var exampleCompleteRedirectUrl= "https://supplier-redirect-url.com/complete?token=[%%token%%]&status=[%%status_id%%]"

var hashValue= = SHA256(exampleCompleteRedirectUrl)

var finalRediectUrl = "https://supplier-redirect-url.com/complete?token=[%%token%%]&status=[%%status_id%%]&hash=hashValue"

Note The hash query param will be automatically added in the redirect url, if encryption is enabled

Server to Server (S2S) Redirect Urls

We support S2S rediects for enhanced security and avoid tempering with urls

Redirect Type	Required	Description
Complete	Yes	Postback url to be used when respondent has completed the survey
Terminate	Yes	Postback url to be used when respondent is not qualified
Overquota	Yes	Postback url to be used when the requierd quota is met
Security Terminate	Yes	Postback url if the respondent fails security checks

Suppliers can update their redirects via redirect-urls endpoint

Urls

Survey Entry Url#

Survey entry url parameters#

Addtional parameters#

Email Hash#

Demographics#

Redirect/Postback Urls#