Enable Mobile Signing

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

Signature mobileSignature = SignatureBuilder
    .mobileCaptureFor("mail32@example.com")
    .onPage(0)
    .atPosition(100, 100)
    .build();

.NET SDK

Signature mobileSignature = SignatureBuilder
    .MobileCaptureFor("mail32@example.com")
    .OnPage(0)
    .AtPosition(100, 100)
    .Build();

REST API

To download the full code sample see our Code Share site. You can also see this feature in our Interactive Demo. If you're unable to use Mobile Capture Signatures, contact our Support Team to have it enabled for your account.

The OneSpan Sign electronic signature mobile app provides a convenient way to send and e-sign documents from your mobile device. Users that already have a OneSpan Sign account can access their account from the mobile app.

Adding a Mobile Capture Signature

The sample JSON payload below shows you how to create a package with a mobile capture signature on a document.

HTTP Request

POST /api/packages

HTTP Headers

Accept: application/json   
Content-Type: multipart/form-data   
Authorization: Basic api_key 

Request Payload

-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t Content - Disposition: form - data;
name = "file";
filename = "testDocumentExtraction.pdf"
Content - Type: application / pdf % PDF - 1.5 % µµµµ 1 0 obj < >>> endobj....-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t Content - Disposition: form - data;
name = "payload" {
   "documents": [{
      "approvals": [{
         "id": "ExampleSignatureId",
         "role": "Signer1",
         "fields": [{
            "page": 0,
            "top": 100,
            "subtype": "MOBILE_CAPTURE",
            "height": 50,
            "left": 100,
            "width": 200,
            "type": "SIGNATURE",
            "name": "ExampleSignatureId"
         }],
         "name": ""
      }],
      "id": "sample-contract",
      "name": "Example document"
   }],
   "status": "SENT",
   "type": "PACKAGE",
   "roles": [{
      "id": "Signer1",
      "type": "SIGNER",
      "signers": [{
         "email": "mail32@example.com",
         "firstName": "John",
         "lastName": "Smith",
         "id": "Signer1"
      }],
      "name": "Signer1"
   }],
   "name": "Mobile Capture Example Package"
}-- -- --WebKitFormBoundary1bNO60n7FqP5WO4t--

For a complete description of each field, see the Request Payload table below.

Response Payload

{
    "id": "9sKhW-h-qS9m6Ho3zRv3n2a-rkI="
}

Results

Once your signers are ready to sign, they will have the option to either sign using their mobile device or sign directly through your application.

Request Payload Table

APEX SDK

  String roleId = 'b9bb2f89-4a27-4c9a-80fc-aaad70f8cac8';
ESignLiveAPIObjects.Field field_mobile_capture = new ESignLiveAPIObjects.Field();
field_mobile_capture.id = 'field_mobile_capture';
field_mobile_capture.type = 'SIGNATURE';
field_mobile_capture.subtype = 'MOBILE_CAPTURE';
field_mobile_capture.page = 0;
field_mobile_capture.top = 100.0;
field_mobile_capture.left = 50.0;
field_mobile_capture.width = 150.0;
field_mobile_capture.height = 50.0;
ESignLiveAPIObjects.Approval approval_mobile_capture = new ESignLiveAPIObjects.Approval();
approval_mobile_capture.fields = new List < ESignLiveAPIObjects.Field > {
   field_mobile_capture
};
approval_mobile_capture.id = 'approval_mobile_capture';
approval_mobile_capture.role = roleId;