In case you don't want to expose the target URL or other parameters to the respondent, you can use an encrypted invite link. Invite link can be genereated with Verify API.

Important

Encrypted parameters are changed to be lowercase (keys and values) and the order of the parameters is not preserved.

The API endpoints are segmented by region as follows:

The request method is POST /api/v1/redirect/generate-invite-link.

Authorization header:

  • X-Api-Key: Account API-Key

The API Key is avialable in the Developers Portal.

The request body is:

{
  "projectSlug": "string",
  "queryString": "string"
}

Where:

  • projectSlug is the unique identifier of the project. It can be found in the project settings in the Project Designer.
  • queryString is the query string that you would like to encode into the invite link.
Important

There is a precedency order for project setting evaluation. Project settings is the base configuration for the invite link. There are some project settings that can be overridden by query string parameters. The order of precedence is the following:

  • encrypted invite link queryString parameters >> non-encrypted query string parameters placed at the end of the invite link (exposed to the respondent)

The following project settings can be overridden / set with queryString parameters:

  • targetUrl (if different URL per session is set in the project settings)
  • returnUrl (if different URL per session is set in the project settings)
  • userId
  • panelProvider
  • age
  • gender

Encrypted query string parameters are part of the invite link so they are not exposed the the respondent, while non-encrypted query string parameters are visible parameters (exposed to the respondent) at the end of the invite link.

Besides the above mentioned project settings parameters, you can also set any custom parameters what you would like to hide from the respondent.

The response body is:

{
  "inviteLink": "string",
  "errorMessage": "string"
}

Where:

  • inviteLink the Verify Service link contains the encrypted parameters.
  • errorMessage is the error message in case of an error.
Warning

An invite link can be used multiple times, each time a new verification session is created.