Adding, Updating, and Removing Signers

To download the full code sample see our Code Share site.

One of the most fundamental and basic operations in OneSpan Sign is that of inviting signers to sign documents. This topic describes how to add, update, and remove signers from a transaction.

Adding Signers to a Transaction

To add a signer to an existing transaction, you must first create the Signer object. The following code will create a Signer object:

Signer signer = SignerBuilder.newSignerWithEmail("signer@example.com")
    .withFirstName("John")
    .withLastName("Smith")
    .withCustomId("Signer1")
    .build();

For information on updating the authentication methods used for transactions, see Authenticating Signers.

Once the Signer object has been created, find the PackageId returned to you during the transaction creation and use the OneSpan Sign client to add your signer. The following code will do this:

String signerId = eslClient.getPackageService().addSigner(packageId, signer);

Updating an Existing Signer

Similarly, to update an existing signer, you must create a Signer object that contains the updates you want to make to your signer. The following code will do this:

Signer updatedSigner = SignerBuilder.newSignerWithEmail("mary.doe@example.com")
    .withFirstName("Mary")
    .withLastName("Doe")
    .withCustomId("Signer1")
    .build();

Once you have updated the signer, find the PackageId (the transaction) that you wish to change this signer in, and use the OneSpan Sign client to update the signer.

eslClient.getPackageService().updateSigner(packageId, updatedSigner);

Removing Signers From a Transaction

To remove a signer from a transaction, simply call the removeSigner function with the packageId and signerId string.

 eslClient.getPackageService().removeSigner(packageId, signerId); 

Results

After running your code, if you login to OneSpan Sign and navigate to your package, you will see your signer in your transaction.

To download the full code sample see our Code Share site.

One of the most fundamental and basic operations in OneSpan Sign is that of inviting signers to sign documents. This topic describes how to add, update, and remove signers from a transaction.

Adding Signers to a Transaction

To add a signer to an existing transaction, you must first create the Signer object. The following code will create a Signer object:

Signer signer = SignerBuilder.NewSignerWithEmail("signer@example.com")
    .WithFirstName("John")
    .WithLastName("Smith")
    .WithCustomId("Signer1")
    .Build();

Once you have updated the signer, find the PackageId (the transaction) that you wish to change this signer in, and use the OneSpan Sign client to update the signer.

String signerId = eslClient.PackageService.AddSigner(packageId, signer);

For information on updating the authentication methods used for transactions, see Authenticating Signers.

Updating an Existing Signer

Similarly, to update an existing signer, you must create a Signer object that contains the updates you want to make to your signer. The following code will do this:

Signer updatedSigner = SignerBuilder.NewSignerWithEmail("mary.doe@example.com")
    .WithFirstName("Mary")
    .WithLastName("Doe")
    .WithCustomId("Signer1")
    .Build();

Once you have updated the signer, find the PackageId (the transaction) that you wish to change this signer in, and use the OneSpan Sign client to update the signer.

 eslClient.PackageService.UpdateSigner(packageId, updatedSigner); 

Removing Signers From a Transaction

To remove a signer from a transaction, simply call the removeSigner function with the packageId and signerId string.

eslClient.PackageService.UpdateSigner(packageId, updatedSigner);

Results

After running your code, if you login to OneSpan Sign and navigate to your package, you will see your signer in your transaction.

To download the full code sample see our Code Share site.

One of the most fundamental and basic operations in OneSpan Sign is that of inviting signers to sign documents. This topic describes how to add, update, and remove signers from a transaction.

Adding Signers to a Transaction

To add a signer to an existing transaction, you must first create the Signer object. The following code will create a Signer object:

ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role();
role.id = 'signer1';
role.signers = sdk.createRolesSigner('John', 'Smith', 'signer@example.com', 'CEO', 'ABC Bank');
sdk.helper.createRole(packageId, role);

Once the Signer object has been created, find the PackageId returned to you during the transaction creation and use the OneSpan Sign client to add your signer. The following code will do this:

ESignLiveAPIObjects.Role retrievedRole = sdk.getRole(packageId, 'signer1');

For information on updating the authentication methods used for transactions, see Authenticating Signers.

Updating an Existing Signer

To update an existing signer, simply modify any of your Signer attributes, by retrieving that signer. All attributes, with the exception of RoleID, can be modified.The following code will do this:

retrievedRole.signers.get(0).firstName = 'changed firstname';
retrievedRole.signers.get(0).lastName = 'changed lastname';
retrievedRole.signers.get(0).email = 'changed@example.com';

Then, find the PackageId you wish to change this signer in and use the OneSpan Sign sdk to update the signer.

 sdk.updateRole(packageId,'signer1',retrievedRole); 

Removing Signers from a Transaction

To remove a signer from a transaction, simply call the deleteRole function with the packageID and roleId string.

 sdk.helper.deleteRole(packageId, 'signer1'); 

Results

After running your code, if you login to OneSpan Sign and navigate to your package, you will see your signer in your transaction.