▲ Top

Signature Image Extraction

This section describes the following ways of extracting images of signatures:

This guide’s REST API chapter provides an overview of certain basic API calls. If you want to view all existing calls, see the REST API Object Model. Additional information about the calls can be found on the Developer Community website. That site’s Feature Guides may be especially helpful when you’re building your solution.

Extract a Sender's Captured Signature from an Account

GET /account/senders/{senderId}/signatureImage

Description

Extract the image of a sender's captured signature from their account. An Account Manager can extract the signature image for any sender. The default image size is 350 x 100 pixels.

Note that:

  • If the sender doesn't exist or if the sender doesn't have a captured signature, an error.notFound.userNotFound exception is thrown.
  • If the image type is invalid or is not supported, an error.validation.signatureImageType exception is thrown.
  • This feature became available in version 6.0.1 of OneSpan Sign.

Resource Information

HTTP Method GET
Resource Family signatureImage
Authentication Authentication Tokens
Content-type application/json
Accept image/png(default)image/jpegimage/gif

Path Parameters

senderId Unique identifier of a OneSpan Sign sender

Example Request

GET http://esl.eSignLive.com.com:8080/aws/rest/services/account/senders/219b6c4f-7b87-4f3e-afec-c922442bd4d0/signatureImage

Response Payload

[image/prn]

Extract a Signer’s Captured Signature from a Package

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

Description

Extract the image of a specific signer’s captured signature from a package. An Account Manager can extract signature images from any package, and Package Owners can extract signature images from the packages they own. The default image size is 350 x 100 pixels.

Note that:

  • If the sender doesn't exist or if the sender doesn't have a captured signature, an error.notFound.userNotFound exception is thrown.
  • If the image type is invalid or is not supported, an error.validation.signatureImageType exception is thrown.
  • If the signer has multiple captured signatures within the package, the first MOBILE_CAPTURE signature (by accepted date) will be taken. If a MOBILE_CAPTURE signature does not exist, the first “CAPTURE” signature (by accepted date) will be taken.
  • This feature became available in version 6.0.1 of OneSpan Sign.

Resource Information

HTTP Method GET
Resource Family signatureImage
Authentication Authentication Tokens
Content-type application/json
Accept image/png(default)image/jpegimage/gif

Path Parameters

packageId Unique identifier of a OneSpan Sign package
roleId Unique identifier of a OneSpan Sign Role

Example Request

GET http://esl.eSignLive.com.com:8080/aws/rest/services/packages/b849f604-3d3b-4ce5-848a-1ecabb4b9edc/roles/IQ8sTODVsfsI/signatureImage

Response Payload

[image/png]