URL Parameterization

URL parameterization applies specifically to the RequestByBusinessUrl method. Because this method generates a single shared URL for all recipients under a payer, it does not inherently identify which recipient submitted a given form.

To track submissions, append a PayeeRef query parameter to the generated secure URL before sharing it. When the recipient submits the form, the ‘WhCertificate Status Change’ webhook will return the same PayeeRef, allowing you to map the submission to the correct vendor.

Example

If the generated SecureURL is: "https://snowda_388311.esignw9.com", you can add PayeeRef as shown below:
"https://snowda_388311.esignw9.com/?payeeref=user001"

Common use cases

• Vendor Portal — Embed the Secure URL in each vendor's portal page. Append a unique PayeeRef (e.g., the vendor's internal ID) after authentication so submissions are automatically tied to the right account.

• Email Distribution — Include the Secure URL with a PayeeRef in bulk vendor invitation emails. Each vendor receives a different link, enabling direct mapping when they submit.

PayeeRef rules

Allowed Characters	Restricted Characters*
Alphabets (A-Z, a-z)	+
Numbers (0-9)	" (double quote)
Special Characters: !@#$%^&*()_-=[]|:;'<>?,./~`	\ (backslash)

* If these characters are found in the input, they will be removed before saving the value.

Encoding Considerations

When passing the PayeeRef parameter in a URL, certain special characters must be URL-encoded to ensure proper handling. Below is the encoding reference:

Character	Encoded Value
Space	%20 or +
!	%21
#	%23
$	%24
%	%25
&	%26
'	%27
*	%2A

Character	Encoded Value
(	%28
)	%29
,	%2C
/	%2F
:	%3A
;	%3B
=	%3D
?	%3F

Character	Encoded Value
@	%40
[	%5B
]	%5D
<	%3C
>	%3E
^	%5E
{	%7B
}	%7D

Special characters such as . _ - ~ do not require encoding.