Retrieving Signing Status

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

Once a transaction as been created, you can retrieve the signing status of that transaction, or of a particular signer.

It is strongly recommended that you use a Callback Listener instead of polling for transaction statuses. The use of polling may consume unnecessary resources on both your end, and on the OneSpan Sign service.

OneSpan Sign transactions follow a predefined lifecycle, defined by the following lifecycle states:

• Draft: The transaction has not yet been sent.

• In progress: The transaction has been distributed for signatures, but has not yet been completed.

• Completed: The transaction has been signed by all recipients.

• Opted out: The transaction has at least one recipient who has opted out of signing the transaction electronically. Note: The opt-out option has been removed from the Signer Experience.

• Declined: The transaction has at least one recipient who has declined to sign the transaction.

• Expired: The transaction has expired (i.e., its expiry date is in the past).

• Archived: The transaction has been archived.

The following diagram outlines the flow a transaction normally goes through. In addition, included in this diagram or two possible actions that you can take during this lifecycle process.

• Trash Action: The Trash action is used to move a selected transaction to the Trash folder. Transactions in the trash folder are not automatically deleted, unless there is a specific retention policy set for that account. Transactions that are manually deleted from this folder are recoverable for two weeks after deletion. To recover these transactions you must contact our Support Team.

• Delete Action: Your package will be permanently deleted and cannot be reinstated.

  

The first step is to create your PackageId object. The following code will do this:

 PackageId packageId = new PackageId("XB4m3cocNudSPEAoUDCIZgbkZD4="); 

Then, you use the OneSpan Sign client to query the status of the transaction and of a signer. The following code will do this:

 com.silanis.esl.sdk.SigningStatus pkgStatus =
    eslClient.getSigningStatus(packageId, null, null);
com.silanis.esl.sdk.SigningStatus signerStatus1 =
    eslClient.getSigningStatus(packageId, new SignerId(signerId1), null);

Results

Once you have retrieved the signing status, do a System.out.println() of each SigningStatus object.

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 as been created, you can retrieve the signing status of that transaction, or of a particular signer.

It is strongly recommended that you use a Callback Listener instead of polling for transaction statuses. The use of polling may consume unnecessary resources on both your end, and on the OneSpan Sign service.

OneSpan Sign transactions follow a predefined lifecycle, defined by the following lifecycle states:

• Draft: The transaction has not yet been sent.

• In progress: The transaction has been distributed for signatures, but has not yet been completed.

• Completed: The transaction has been signed by all recipients.

• Opted out: The transaction has at least one recipient who has opted out of signing the transaction electronically. Note: The opt-out option has been removed from the Signer Experience.

• Declined: The transaction has at least one recipient who has declined to sign the transaction.

• Expired: The transaction has expired (i.e., its expiry date is in the past).

• Archived: The transaction has been archived.

The following diagram outlines the flow a transaction normally goes through. In addition, included in this diagram or two possible actions that you can take during this lifecycle process.

• Trash Action: The Trash action is used to move a selected transaction to the Trash folder. Transactions in the trash folder are not automatically deleted, unless there is a specific retention policy set for that account. Transactions that are manually deleted from this folder are recoverable for two weeks after deletion. To recover these transactions you must contact our Support Team.

• Delete Action: Your package will be permanently deleted and cannot be reinstated.

  

The first step is to create your PackageId object. The following code will do this:

 PackageId packageId = new PackageId("XB4m3cocNudSPEAoUDCIZgbkZD4="); 

Then, you use the OneSpan Sign client to query the status of the transaction and of a signer. The following code will do this:

 Silanis.ESL.SDK.SigningStatus signerStatus1 =
    eslClient.GetSigningStatus(packageId, signerId1, null);
Silanis.ESL.SDK.SigningStatus pkgStatus =
    eslClient.GetSigningStatus(packageId, null, null);

Results

Once you have retrieved the signing status, do a Debug.WriteLine() of each SigningStatus object.

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 as been created, you can retrieve the signing status of that transaction, or of a particular signer.

It is strongly recommended that you use a Callback Listener instead of polling for transaction statuses. The use of polling may consume unnecessary resources on both your end, and on the OneSpan Sign service.

OneSpan Sign transactions follow a predefined lifecycle, defined by the following lifecycle states:

• Draft: The transaction has not yet been sent.

• In progress: The transaction has been distributed for signatures, but has not yet been completed.

• Completed: The transaction has been signed by all recipients.

• Opted out: The transaction has at least one recipient who has opted out of signing the transaction electronically. Note: The opt-out option has been removed from the Signer Experience.

• Declined: The transaction has at least one recipient who has declined to sign the transaction.

• Expired: The transaction has expired (i.e., its expiry date is in the past).

• Archived: The transaction has been archived.

The following diagram outlines the flow a transaction normally goes through. In addition, included in this diagram or two possible actions that you can take during this lifecycle process.

• Trash Action: The Trash action is used to move a selected transaction to the Trash folder. Transactions in the trash folder are not automatically deleted, unless there is a specific retention policy set for that account. Transactions that are manually deleted from this folder are recoverable for two weeks after deletion. To recover these transactions you must contact our Support Team.

• Delete Action: Your package will be permanently deleted and cannot be reinstated.

  

The following code will do this:

HTTP Request

GET /api/packages/{packageId}/signingStatus?signer={signerId}&document={documentId}

HTTP Headers

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

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

Response Payload

 {   "status": "DRAFT"   } 

Where the packageId is returned to you during transaction creation. Optionally, you can add the signerId and documentId parameters to retrieve the signing status of a signer or document.

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 as been created, you can retrieve the signing status of that transaction, or of a particular signer.

It is strongly recommended that you use a Callback Listener instead of polling for transaction statuses. The use of polling may consume unnecessary resources on both your end, and on the OneSpan Sign service.

OneSpan Sign transactions follow a predefined lifecycle, defined by the following lifecycle states:

• Draft: The transaction has not yet been sent.

• In progress: The transaction has been distributed for signatures, but has not yet been completed.

• Completed: The transaction has been signed by all recipients.

• Opted out: The transaction has at least one recipient who has opted out of signing the transaction electronically. Note: The opt-out option has been removed from the Signer Experience.

• Declined: The transaction has at least one recipient who has declined to sign the transaction.

• Expired: The transaction has expired (i.e., its expiry date is in the past).

• Archived: The transaction has been archived.

The following diagram outlines the flow a transaction normally goes through. In addition, included in this diagram or two possible actions that you can take during this lifecycle process.

• Trash Action: The Trash action is used to move a selected transaction to the Trash folder. Transactions in the trash folder are not automatically deleted, unless there is a specific retention policy set for that account. Transactions that are manually deleted from this folder are recoverable for two weeks after deletion. To recover these transactions you must contact our Support Team.

• Delete Action: Your package will be permanently deleted and cannot be reinstated.

  

The following function allows you to query a status:

 public String getSigningStatus(String packageId, String signerId, String documentId) 

You can also query the status of a package or of a signer or of a signer with specific document ID. The following code will do tihs:

 String pkgStatus = getSigningStatus('_AQlDyjbxVLphMfM0oPG5YuioTU=',null,null);   String signer1Status = getSigningStatus('_AQlDyjbxVLphMfM0oPG5YuioTU=','signer1@example.com',null);   String signer1Document1Status = getSigningStatus('_AQlDyjbxVLphMfM0oPG5YuioTU=','signer1@example.com','document1'); 

Results

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