Single Signer Package

Hi Michail,

Thanks for your post! With OneSpan Sign RESTful API, you have the flexibility to create and tailor the package to your demands. To create a one document one signer package, you can refer to the JSON used in the Quick Start Guide or below example:

{
  "roles": [
    {
      "id": "Role1",
      "signers": [
        {
          "email": "[email protected]",
          "firstName": "1.firstname",
          "lastName": "1.lastname",
          "company": "OneSpan Sign"
        }
      ]
    }
  ],
  "documents": [
    {
      "approvals": [
        {
          "role": "Role1",
          "fields": [
            {
              "page": 0,
              "top": 100,
              "subtype": "FULLNAME",
              "height": 50,
              "left": 100,
              "width": 200,
              "type": "SIGNATURE"
            }
          ]
        }
      ],
      "name": "Test Document"
    }
  ],
  "name": "Example Package",
  "type": "PACKAGE",
  "language": "en",
  "emailMessage": "",
  "description": "New Package",
  "autocomplete": true,
  "status": "SENT"
}

Duo

Hello Duo,

Thanks for your response.

How could I do it in Java?

In the  Quick Start Guide it is always two signers to be added in the package.

Thanks and Regards,

Michail

Sure, here you are!

DocumentPackage documentPackage = PackageBuilder.newPackageNamed("Test Package Java SDK")

    .withSigner(SignerBuilder.newSignerWithEmail("[email protected]")
        .withCustomId("Signer")                          
        .withFirstName("SignerFirstName")
        .withLastName("SignerLastName"))                         

    .withDocument(DocumentBuilder.newDocumentWithName("sampleAgreement")
        .withId("document1")                              
        .fromFile("your_file_path")
        .withSignature(SignatureBuilder.signatureFor("[email protected]")
                .withId(new SignatureId("signature1"))    
                .onPage(0)
                .atPosition(175, 165)))

    .autocomplete(true)

   .build();

PackageId packageId = eslClient.createPackageOneStep(documentPackage);
 
eslClient.sendPackage(packageId);

Duo

Hello Duo,

As I see in your last answer, you have set the  "autocomplete" of the DocumentPackage to TRUE. Does it mean that after the signature of the single signer, the status of the package will be set to completed?

If yes, what is the notification which will be sent by OneSpan in this case?

Normally, when we have more than one signers, we get the SIGNER_COMPLETE once the 1st signer signs, and the PACKAGE_COMPLETE when the last signer signs.

What is the notification in this case, for a single signer only?

Thanks,

Michail

Hi Michail,

For your questions:
- yes, with "autoComplete" on, the package will be automatically set to completed once the single signer has completed signing. 

- both "SIGNER_COMPLETE" and "PACKAGE_COMPLETE" events will be triggered.

Duo

Hello Duo,

As discussed earlier, I tried to create a package for a single signer (a customer), using Java.

The package will be created for the account cmcicnor@XXX in US1 Sandbox.

Unfortunately, when I try to create the package, I get the following error:

No role found for signer email CMCICESIGN@XXX

I don't want to use the CMCICESIGN@XXX as a signer. Do you have any idea why it fails?

PS. I replaced the domain of the emails with XXX

Thanks,

Michail

Hi Michail,

Try to use createPackage() function instead of createPackageOneStep() and see if this solves the issue:

        PackageId pkgId = eslClient.createPackage(pkg);

If this doesn't make any difference, please share the account email and the codes around package building to [email protected] so that I can have a closer look at your package structure. 

Duo
 

Hi Duo,

This is what I have used:

EslClient eslClient = ESLCreatePackageRequest.getESLClient(epvAccountMapping.getApiKey());
DocumentPackage documentPackage = createPackageRequest.buildPackage(epvDynamics, epvAccountMapping);
PackageId packageId = eslClient.createPackage(documentPackage);

Do you see something wrong?

Regards,

Michail

Hi Michail,

"No role found for signer email xxx" is typically caused by the mismatch between the signer list and the signature email. Please make sure the signer list contains all the emails or the code didn't mistakenly pass in a wrong email.

DocumentPackage documentPackage = PackageBuilder.newPackageNamed("Test Package Java SDK")

    .withSigner(SignerBuilder.newSignerWithEmail("cmcicnor@XXX")
        .withCustomId("Signer1")                          
        .withFirstName("SignerFirstName")
        .withLastName("SignerLastName"))                         

    .withDocument(DocumentBuilder.newDocumentWithName("sampleAgreement")
        .fromFile("your_file_path")
        .withSignature(SignatureBuilder.signatureFor("CMCICESIGN@XXX")
                .onPage(0)
                .atPosition(175, 165)))

   .build();

PackageId packageId = eslClient.createPackage(documentPackage);

Duo

Hello Duo,

Thank you! I have fixed it.

As described by you above, I set the "autoComplete" to "on". For single signer packages, you said that both "SIGNER_COMPLETE" and "PACKAGE_COMPLETE" events will be triggered.

Unfortunately, for my package, I have only received the "SIGNER_COMPLETE".

My package ID is PY70PlVW6zGnUB5rMupPuu1SG4g= in US1 Sandbox.

Could you please have a look?

Thanks and Regards,

Michail

Hi Michail,

Just checked with our support team and seems your package "PY70PlVW6zGnUB5rMupPuu1SG4g=" has autocompleted : false and the package status is still SENT. Did you assign any required attachment to your signer? (Required attachment will force sender to accept manually)

Duo

Many thanks Duo!

Yes, I had some required attachments in this package id.

I tried again without required attachments and it worked as expected. I got the SIGNER_COMPLETE and the PACKAGE_COMPLETE.

Best Regards
Michail