RetrievingAll Signatures

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

Once a transaction has been sent out for signing, you can retrieve all signatures on a specified document, for a specified signer. The following code will do this:

If you need a comparison to the basic object creation procedure, or if this is the first time creating a transaction, see Creating and Sending a Transaction.

Firs, retrieve your DocumentPackage object. The following code will do this:

DocumentPackage sentPackage = client.getPackage(packageId);

Then, using the OneSpan SignApprovalService, you can retrieve all signatures. Use the DocumentPackage, SignatureID objects, and documentID as parameters. The following code will do this:

List<Signature> signer1SignableSignatures = client
    .getApprovalService()
    .getAllSignableSignatures(sentPackage, documentId, signer1Id);

Finally, you can loop through each signature to retrieve any additional information, like the positioning of the signature, the accepted date, and so on.

for (Signature signature : signer1SignableSignatures) {
    System.out.println("Position of signature " + i + ": (" + signature.getX() + ", " + signature.getY() + ") on page " + signature.getPage());
    i++;
}

If the package contains an “accept only” document then the Approvals node will not have any signatures in it.

Results

Here is an example of what you can expect to see once you have run your code.

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

Once a transaction has been sent out for signing, you can retrieve all signatures on a specified document, for a specified signer. The following code will do this:

If you need a comparison to the basic object creation procedure, or if this is the first time creating a transaction, see Creating and Sending a Transaction.

Firs, retrieve your DocumentPackage object. The following code will do this:

 DocumentPackage sentPackage = client.GetPackage(packageId); 

Then, using the OneSpan SignApprovalService, you can retrieve all signatures. Use the DocumentPackage, SignatureID objects, and documentID as parameters. The following code will do this:

IList<Signature> signer1SignableSignatures = client.ApprovalService
    .GetAllSignableSignatures(sentPackage, documentId, signer1Id);

Finally, you can loop through each signature to retrieve any additional information, like the positioning of the signature, the accepted date, and so on.

foreach (Signature signature in signer1SignableSignatures)
{
    Debug.WriteLine("Position of signature " + i + ": (" + signature.X + ", " + signature.Y + ") on page " + signature.Page);
    i++;
}

If the package contains an “accept only” document then the Approvals node will not have any signatures in it.

Results

Here is an example of what you can expect to see once you have run your code.

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

Once a transaction has been sent out for signing, you can retrieve all signatures on a specified document, for a specified signer. The following code will do this:

If you need a comparison to the basic object creation procedure, or if this is the first time creating a transaction, see Creating and Sending a Transaction.

Firs, retrieve your PackageID. The following code will do this:

Then, you can retrieve all signatures. Use the PackageID, SignatureID , and documentID as parameters. The following code will do this:

public List<ESignLiveAPIObjects.Approval> getAllSignableSignatures(
    String packageId, 
    String documentId, 
    String signerId
)

Finally, you can loop through each signature to retrieve any additional information, like the positioning of the signature, the accepted date, and so on.

List<ESignLiveAPIObjects.Approval> allSignableSignatures = getAllSignableSignatures(packageId, documentId, signerId);

for (ESignLiveAPIObjects.Approval approval : allSignableSignatures) {
    System.debug('Approval ID: ' + approval.id);
    
    if (approval.fields != null && approval.fields.size() > 0) {
        for (ESignLiveAPIObjects.Field field : approval.fields) {
            System.debug('----Field ID: ' + field.id + ', TYPE: ' + field.type + ' ' + field.subtype);
        }
    }
}

If the package contains an “accept only” document then the Approvals node will not have any signatures in it.

Results

Here is an example of what you can expect to see once you have run your code.