Signing URL

This guide shows you to get the signing url for a signer.

Once you’ve sent your document package for signing, you may want to create a signing session for your signers. To do this, you can either create a session token and build the url redirect or you can simply retrieve the signing url. The difference between building the url with a session token and the signing url is the latter does not expire.

The Code

You can get the complete example code from the Developer Community Code Share, here.

The first step is to create the PackageId object of your document package. If you need a comparison to the basic document object creation or if this is the first time creating a package with the Java SDK, see this guide.

It is important to note that your document package must be in SENT status. Otherwise, an exception will be thrown. Once you have your PackageId object, you use OneSpan Sign’s ApprovalService and pass the PackageId object and SignerId String as parameters to retrieve the signing url.

String signerId = "Signer1";
String packageid = "your_package_id";
		
EslClient eslClient = new EslClient(API_KEY, API_URL);
		
PackageId packageId = new PackageId(packageid);
		
String signingUrl = eslClient.getPackageService().getSigningUrl(packageId, signerId);
		
System.out.println(signingUrl);

Running Your Code

Below is a screenshot of the console output you can expect once you’ve run your code.

Capture

Get the Code

Once you’ve sent your document package for signing, you may want to create a signing session for your signers. To do this, you can either create a session token and build the url redirect or you can simply retrieve the signing url. The difference between building the url with a session token and the signing signing url is that the latter does not expire.

The Code

You can get the complete example code from the Developer Community Code Share, here.

The first step is to create the PackageId object of your document package. If you need a comparison to the basic document object creation or if this is the first time creating a package with the .NET SDK, see this guide.

It is important to note that your document package must be in SENT status. Otherwise, an exception will be thrown. Once you have your PackageId object, you use OneSpan Sign’s ApprovalService and pass the PackageId object and SignerId String as parameters to retrieve the signing url.

string signerId = "Signer1";
string packageid = "your_package_id";
		
EslClient eslClient = new EslClient(API_KEY, API_URL);
		
PackageId packageId = new PackageId(packageid);

string signingUrl = eslClient.PackageService.GetSigningUrl(packageId, signerId);
		
Debug.WriteLine(signingUrl);

Running Your Code

Below is a screenshot of the console output you can expect once you’ve run your code.

Capture

Get the Code

Once you’ve sent your document package for signing, you may want to create a signing session for your signers. To do this, you can either create a session token and build the url redirect or you can simply retrieve the signing url. The difference between building the url with a session token and the signing signing url is that the latter does not expire.

The Code

You can get the complete example code from the Developer Community Code Share, here.

The first step is to retrieve the package id, which is returned to you during package creation. If you need a comparison to the basic document object creation or if this is the first time creating a package with the REST API, see this guide. Once you have your package id, you will then need to retrieve the role id and then make the following request:

HTTP Request
GET /api/packages/{packageId}/roles/{roleId}/signingUrl

HTTP Headers
Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Response Payload

{
  "roleId": "2jsTTXD2dZMZ",
  "url": "https://sandbox.e-signlive.com/auth?target=https%3A%2F%2Fsandbox.esignlive.com\r\n%2Fpackages%2FnaXQwWFSQB9RkOiH6AguBCkXp2k=%2Fsign&loginToken=\r\nMi4xMDAwGpGY3JJPS55ZnNSeHBmekNxc1RzdnNJRVlBSDkZBR1RhcmxKS09aZ3M4aFZXVlpvdExrdz09",
  "packageId": "a3b023bf-db56-4c53-b36e-bd9acd0579f4"
}

Running Your Code

Below is a screenshot of the console output you can expect once you’ve run your code.

Capture

Get the Code

Once you’ve sent your document package for signing, you may want to create a signing session for your signers. To do this, you can either create a session token and build the url redirect or you can simply retrieve the signing url. The difference between building the url with a session token and the signing url is the latter does not expire.

The Code

To notice, some of the code is an extension of the APEX SDK and can be gotten through this Code Share.

The first step is to create a package. If you need a comparison to the basic package creation or if this is the first time creating a package with the Apex SDK, see this guide.

It is important to note that your document package must be in SENT status. Otherwise, an exception will be thrown.
Once you retrieved your package ID, you use below encapsulated function and pass the package ID and Role ID as parameters to retrieve the signing url.

public String getSigningUrl(String packageId, String roleId)

Running Your Code

Below is a screenshot of the console output you can expect once you’ve run your code.

Capture

Get the Code