Unique ID

VerifyPass allows Unique ID (uid) tracking via a URL parameter or when creating an Applicant Token. Unique ID functions as your internal tracking mechanism only—the result will be returned via your Webhook.

Methods

Because uid can be set either by URL Parameter or by Applicant Token, it's important to understand the distinction between each method.

URL Parameter: should not be authoritatively relied upon for critical functionality. A client can modify/remove the URL parameter.

Applicant Token: in combination with Require Applicant Token, can be relied upon for critical functionality, such as account tagging.

Requirements

uid must not exceed 256 characters in length.
uid as a URL parameter should contain URL-friendly characters. Don't use &, for example.
Only works with your Webhook. uid is not a searchable or reportable parameter.

Usage: Parameter

Warning: You should encrypt internal data, such as a Customer ID, to ensure it isn't modified in a meaningful or harmful way by the client.

Businesses will use uid to track a specific applicant. Most commonly, this purpose will include ensuring the correct account is tagged, or for tracking marketing efforts, such as a referral source.

https://verifypass.com/auth/{your-widget-key}?uid={unique_id}

After verification, your applicant's uid will be passed within your Webhook.

Usage: Applicant Token

Refer to the Applicant Token documentation.

Tracking Multiple Parameters

When multiple data points are required, it is recommended to store them as key:value pairs using your preferred URL-friendly format.

For example:

https://verifypass.com/auth/{your-widget-key}?uid=custID:{encrypted_ID},ref:{referrer}

Reminder: uid length cannot exceed 256 characters.

Overview

Widgets