Extracting Images of Signatures
  • 15 Oct 2024
  • 4 Minutes to read
  • Dark
    Light
  • PDF

Extracting Images of Signatures

  • Dark
    Light
  • PDF

Article summary

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

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

You can extract the signature image for any Sender in your account. When doing so, note the following:

  • The default signature image size is 350 x 100 pixels.

  • If the sender does not exist or the sender does not have a captured signature, an error.notFound.userNotFound exception will be thrown.

  • If the image type is invalid or not supported, an error.validation.signatureImageType exception will be thrown.

  • Images can be in PNG, JPEG, or GIF format.

  • This procedure will only work for signatures of the CAPTURE type.

Extracting Signature Images

To extract a sender's signature as an image file, call on the SignatureImageService and pass the sender id and the format you wish to download the signature in. The following code will do this:

DownloadedFile senderImage = eslClient.getSignatureImageService().getSignatureImageForSender("{senderId}", SignatureImageFormat.PNG);
byte[] senderImageByte = senderImage.getContents();
        
FileOutputStream stream = new FileOutputStream("C:/Users/hhaidary/Desktop/senderImage.png");
        
try {
   stream.write(senderImageByte);
} finally {
   stream.close();
}

Then, open a new FileOutputStream to write the data to a destination of your choice.

For more information on retrieving sender information, see Managing Senders.

Extracting a Specific Signature Image

To download a specific signer’s captured signature from a specific transaction, use the on the SignatureImageService to pass the package id, signer id, and the format you wish to download the signature in. The following code will do this:

PackageId packageId = new PackageId("IP-lS6_GYWlKr4moDNWMEWJOuJc=");
        
DownloadedFile signerImage = eslClient.getSignatureImageService().getSignatureImageForPackageRole(packageId,"signer1", SignatureImageFormat.JPG);
byte[] signerImageByte = senderImage.getContents();
        
stream = new FileOutputStream("C:/Users/hhaidary/Desktop/signerImage.png");
        
try {
   stream.write(signerImageByte);
} finally {
   stream.close();
}

.NET SDK

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

You can extract the signature image for any Sender in your account. When doing so, note the following:

  • The default signature image size is 350 x 100 pixels.

  • If the sender does not exist or the sender does not have a captured signature, an error.notFound.userNotFound exception will be thrown.

  • If the image type is invalid or not supported, an error.validation.signatureImageType exception will be thrown.

  • Images can be in PNG, JPEG, or GIF format.

  • This procedure will only work for signatures of the CAPTURE type.

Extracting Signature Images

To extract a sender's signature as an image file, call on the SignatureImageService and pass the sender id and the format you wish to download the signature in. The following code will do this:

DownloadedFile senderImage = eslClient.SignatureImageService.GetSignatureImageForSender("rNs5hVUQ0mQY", SignatureImageFormat.PNG);
byte[] senderImageByte = senderImage.Contents;  
try
{
    File.WriteAllBytes("C:/Users/hhaidary/Desktop/senderImage.png", senderImageByte);
}
catch(Exception e)
{
    Debug.WriteLine(e);
}

Then, open a new file to write the data to a destination of your choice.

For more information on retrieving sender information, see Managing Senders.

Extracting a Specific Signature Image

To download a specific signer’s captured signature from a specific transaction, use the on the SignatureImageService to pass the package id, signer id, and the format you wish to download the signature in. The following code will do this:

PackageId packageId = new PackageId("IP-lS6_GYWlKr4moDNWMEWJOuJc=");
DownloadedFile signerImage = eslClient.SignatureImageService.GetSignatureImageForPackageRole(packageId,"signer1", SignatureImageFormat.JPG);
byte[] signerImageByte = senderImage.Contents;
try
{
    File.WriteAllBytes("C:/Users/hhaidary/Desktop/signerImage.png", signerImageByte);
}
catch (Exception e)
{
    Debug.WriteLine(e);
}

REST API

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

You can extract the signature image for any Sender in your account. When doing so, note the following:

  • The default signature image size is 350 x 100 pixels.

  • If the sender does not exist or the sender does not have a captured signature, an error.notFound.userNotFound exception will be thrown.

  • If the image type is invalid or not supported, an error.validation.signatureImageType exception will be thrown.

  • Images can be in PNG, JPEG, or GIF format.

  • This procedure will only work for signatures of the CAPTURE type.

Extracting Signature Images

The following code will do this:

HTTP Request

GET /api/account/senders/{senderId}/signatureImage

GET /api/account/senders/{senderId}/signatureImage

HTTP Headers

Accept: image/png,image/jpeg,image/gif
Content-Type: application/json
Authorization: Basic api_key

Response Payload

[image/png]

For more information on retrieving sender information, see Managing Senders.

Extracting a Specific Signature Image

The following code will do this:

HTTP Request

GET /api/packages/{packageId}/roles/{roleId}/signatureImage

GET /api/packages/{packageId}/roles/{roleId}/signatureImage

HTTP Headers

Accept: image/png,image/jpeg,image/gif
Content-Type: application/json
Authorization: Basic api_key

Response Payload

[image/png]

In this case, you will need the package id and role id of the signer.

APEX SDK

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

You can extract the signature image for any Sender in your account. When doing so, note the following:

  • The default signature image size is 350 x 100 pixels.

  • If the sender does not exist or the sender does not have a captured signature, an error.notFound.userNotFound exception will be thrown.

  • If the image type is invalid or not supported, an error.validation.signatureImageType exception will be thrown.

  • Images can be in PNG, JPEG, or GIF format.

  • This procedure will only work for signatures of the CAPTURE type.

Extracting Signature Images

To extract a sender's signature as an image file, use the following encapsulated function to pass the sender ID to download the signature.

    	//Get Signature Image For Sender 
    	String senderId = 'ATQOPd60xE4V';
    	Blob signatureImageForSender = getSignatureImageForSender(senderId);

Then, open a new file to write the data to a destination of your choice.

For more information on retrieving sender information, see Managing Senders.

		//store blob
        Document signatureImageForSenderDocument = new Document();
        signatureImageForSenderDocument.Body = signatureImageForSender;
        signatureImageForSenderDocument.FolderId = folder.id;
        signatureImageForSenderDocument.Name = 'Signature image for sender: '+ senderId +' - ' + Datetime.now().format();
        signatureImageForSenderDocument.Type = 'jpg';
        documents.add(signatureImageForSenderDocument);

Extracting a Specific Signature Image

To download a specific signer’s captured signature from a specific transaction, use the following encapsulated cuntion to pass the package id, signer id.

        String packageId = 'E-cmEaSbHjLDNf631aj3Y8-hvCk=';
        String roleId = 'Signer2'; 
        Blob signatureImageForPackageRole = getSignatureImageForPackageRole(packageId,roleId);


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, our interactive help assistant