Program Settings

Configure advanced program settings such as domain whitelist, targeted subsegments, and more.

Navigate to the Settings tab of your Program page to configure the following settings.

Domain Whitelist

Specify one or more domains that are allowed when the SheerID system processes a verification attempt or conversion attempt.

Domain Whitelist

On the Domain Whitelist card, click the dropdown caret to reveal a form field for your whitelisted domains.

Enter a comma-separated list of domain names, (e.g., my-site.com,support.my-site.com) and click enter.

That’s it! Now SheerID will only process verification or conversion attempts that emanate from the domains that you have specified for your program.

Eligible Subsegments

Select SheerID verification segments support subsegments, which allow you to narrow the scope of your offer to a subset of the whole group.

For example, for a First Responder program, you can target the following subsegments: Firefighter, Emergency Medical Technician, Police.

On the Eligible Subsegments card, click the dropdown caret to reveal a checkbox grouping for the subsegments available for your program.

Example—Subsegments for a Student offer:

Eligible Subsegments

Upon checking or unchecking a subsegment, your changes will be automatically saved.

Emails

Modify your approved and rejected email templates from your Program Settings page.

Note: This feature is available for new progams as of July 10, 2019. Older programs use a different template and are thus uneditable in this section of MySheerID.

Click the dropdown caret on the Emails card to reveal the default email content for approved and rejected verifications. Edit as appropriate.

The styling for the email, including fonts and logo, is inhereted from the styling in your program’s Theme settings.

Approved Email

Once you are satisfied with the content of your emails, click Save. To test the appearance of the emails, see Test Program and generate both approved and rejected emails to verify the user experience.

If you would like to contact end users with marketing messages in the future, activate the Marketing Consent module in you program’s Settings page.

Marketing Consent

On the Marketing Consent card, click the dropdown caret to reveal the three elements of the module.

  1. Click the toggle switch to On to turn on Marketing Consent.
  2. Optionally check the “Marketing Consent is required” box to make consent a required field for getting verified.
  3. Optionally edit the message that accompanies the Marketing Consent option in your verification form. Note that the default {Company Name} template in the text box will pull your company name from your MySheerID account configuration.
  4. Preview your Marketing Consent experience by navigating back to the Program tab and clicking the See Preview button.

Email Opt-In

Metadata Options

If you would like to pass additional key-value pair data with your verification, e.g., "status": "platinum" or "favorite_color": "blue", you may add the key(s) in the Metadata Options card in the Program Settings page.

Metadata Options

On the Metadata Options card, click the dropdown caret to reveal the on/off toggle for the metadata feature and the text box where you will enter your key(s).

  1. Click the toggle switch to On to turn on Metadata.
  2. Enter the name of the key you would like to report on, followed by either a space or a comma. Upon entering the space or comma, your key will be saved in your program.
  3. Repeat the above process if you wish to track multiple key-value pairs in your verification reporting.
Note: We recommend using lowercase letters (and optionally underscores) when defining your keys, e.g., utm_campaign. The keys and the corresponding values will be passed to SheerID in the URL of the verification, and are meant to be human-readable when reviewing reporting data. Including special characters in your key may result in avoidable parsing errors.

Metadata Reporting

Now that your metadata keys are defined for your program, they will appear as column headers in your verification reports, alongside other captured fields such as Request ID, Status, and any others you are collecting. Note that verification reports will only include metadata columns for keys currently specified in your settings, e.g., if you had tracked favorite_color for a month, and then removed it, the report will no longer include the favorite_color column.

Examples

To submit values for your defined keys, simply pass them as parameters in your verificaion URL. Below are two examples. The first example passes a value of bar for the foo key. The second example passes two values: two and blue for the fish_number and fish_color keys, respectively.

https://services.sheerid.com/verify/5d4a5d1a7b9ca962e0b6a901/?foo=bar
https://services.sheerid.com/verify/5d4a5d1a7b9ca962e0b6a901/?fish_number=two&fish_color=blue
Tip: To test if your metadata is being sent properly, go to your Program tab and get the URL from the code snippet that looks like https://services.sheerid.com/verify/YOUR_PROGRAM_ID/, append the parameters as in the examples above, and generate a report.

Webhooks

Use webhooks to be notified when a successful verification occurs for your program, in order to continue moving users through your workflow.

You can define an HTTP callback (webhook) when setting up your program. Once set, SheerID will return the user’s verificationId to the provided URL upon a successful verification. You can use the ID to retrieve all the details about a verification, including user- and program-related information such as reward code and email address, etc.

On the Webhooks card, enter the URL that will receive the callback including the verificationId.

Webhooks

To learn more about using webhooks with SheerID, see our Creating Webhooks Tutorial.