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 parameter 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: Applicant can modify/remove the URL parameter. This is insufficient for critical functionality (such as account tagging), but may be sufficient for less-critical tracking purposes.

Applicant Token: Applicant cannot modify the token. In combination with Advanced → Require Applicant Token, can be trusted for critical functionality (such as account tagging).

Requirements

uid must not exceed 64 characters in length.
uid must contain URL-friendly characters. Don't use &, for example.
uid is sent via Webhook and Reporting API—it isn't available within your account UI.

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.

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

After verification, your applicant's uid will be passed within your Webhook, and made available and searchable within the Reporting API.

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=data1:{data1},data2:{data2}

Reminder: uid length cannot exceed 64 characters.

Overview

Widgets