Delivering Signed Documents

Java SDK .NET SDK REST API APEX SDK

Java SDK

// Create a new document package with a specified name
DocumentPackage superDuperPackage = newPackageNamed(getPackageName())
    // Add a signer with email, first name, and last name, and set to deliver signed documents by email
    .withSigner(newSignerWithEmail("john.smith@example.com")
        .withFirstName("John")
        .withLastName("Smith")
        .deliverSignedDocumentsByEmail())
    // Add a document with a name, input stream, and signature details
    .withDocument(newDocumentWithName("First Document")
        .fromStream(documentInputStream1, DocumentType.PDF)
        .withSignature(signatureFor("john.smith@example.com")
            .onPage(0)
            .atPosition(100, 100)))
    // Build the document package
    .build();

.NET SDK

 // Create a new document package with a specified name and description
DocumentPackage package = PackageBuilder.NewPackageNamed(PackageName)
    .DescribedAs("This is a new package")
    // Add a signer with email, first name, last name, and set to deliver signed documents by email
    .WithSigner(SignerBuilder.NewSignerWithEmail(email1)
        .WithFirstName("John")
        .WithLastName("Smith")
        .DeliverSignedDocumentsByEmail())
    // Add a document with a name, input stream, and signature details
    .WithDocument(DocumentBuilder.NewDocumentNamed("My Document")
        .FromStream(fileStream1, DocumentType.PDF)
        .WithSignature(SignatureBuilder.SignatureFor(email1)
            .OnPage(0)
            .AtPosition(100, 100)))
    // Build the document package
    .Build();

REST API

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

Once a transaction has been completed, you can automatically deliver the signed documents to your signers. The following code will do this:

HTTP Request

POST /api/packages/{packageId}/roles

HTTP Headers

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

Request Payload

{
  "id": "Signer5",
  "reassign": true,
  "type": "SIGNER",
  "signers": [
    {
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "id": "Signer5",
      "delivery": {
        "email": true,
        "download": true,
        "provider": true
      }
    }
  ],
  "name": "Signer5"
}

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

Response Payload

{
  "id": "Signer5",
  "data": null,
  "specialTypes": [],
  "emailMessage": null,
  "attachmentRequirements": [],
  "locked": false,
  "reassign": true,
  "index": 0,
  "signers": [
    {
      "group": null,
      "language": "en",
      "signature": null,
      "id": "Signer5",
      "delivery": {
        "provider": true,
        "email": true,
        "download": true
      },
      "auth": {
        "scheme": "NONE",
        "challenges": []
      },
      "knowledgeBasedAuthentication": null,
      "data": null,
      "title": "",
      "company": "",
      "email": "mail32@example.com",
      "firstName": "John",
      "lastName": "Smith",
      "external": null,
      "updated": "2017-11-16T16:53:01Z",
      "phone": "",
      "professionalIdentityFields": [],
      "userCustomFields": [],
      "address": null,
      "created": "2017-11-16T16:53:01Z",
      "name": "",
      "specialTypes": []
    }
  ],
  "name": "Signer5",
  "type": "SIGNER"
}

Results

Once you've sent your package for signing and the transaction, each of your signers will receive an emails with a link to the signed documents. Documents are normally included in the signing complete email as an attached zip file. If you would like to have these documents delivered as individual files, contact our Support Team.

Request Payload Table

APEX SDK

// Create a new role object
ESignLiveAPIObjects.Role role = new ESignLiveAPIObjects.Role();

// Create a new signer object
ESignLiveAPIObjects.Signer signer = new ESignLiveAPIObjects.Signer();
signer.firstName = 'firstName';
signer.lastName = 'lastName';
signer.email = 'signer@example.com';
signer.name = 'signer1';
signer.id = 'signer1';

// Set delivery options for the signer
signer.delivery = new ESignLiveAPIObjects.Delivery(true, true, true); // Boolean download, Boolean email, Boolean provider

// Assign the signer to the role
role.signers = new List<ESignLiveAPIObjects.Signer>{signer};
role.id = 'signer1';