Java SDK

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.

This section discusses the following topics related to retrieving information about e-signature processes:

Retrieving the OneSpan Sign Version

The following code samples illustrate how to retrieve your version of OneSpan Sign.

Retrieving Information for Technical Support

The following code samples illustrate how to retrieve contact information for our Support Team on a particular package.

Retrieving All Approvals for a Package

The following code samples illustrate how to retrieve all approvals for a specified package.

Retrieving a Package

Once you have begun to create and send document packages, you may want to retrieve the latest version of a package. To do this, you need the ID of the package you want to retrieve.

The following code samples illustrate how to retrieve a package.

Downloading Documents

Once you have begun to create and send packages, you may want to retrieve the latest version of the package's documents. To do this, you need the ID of the package and the IDs of the relevant documents.

The following code samples illustrate how to download: (1) a specific document; (2) the package's Evidence Summary; (3) a zip file that contains all the package's documents.

Downloading Documents Completed in a Date Range

The following code samples illustrate how to download documents that were completed within a specified range of dates.

Retrieving a Package's Status

Once a package has been created, you might want to retrieve just its signing status (instead of the entire object). The following code samples illustrate how to retrieve a package's signing status.

Retrieving Field Values

Once a package has been completed, it may be useful to retrieve the values entered in certain fields. A single call can access all fields in the package.

The following code samples retrieve a list of all fields, and then output their values. The samples assume that: (1) signing is complete for a package that contains fields; (2) you know the package's PackageId.

Retrieving Opt-Out and Decline Reasons

A signer can "opt out" of signing a package electronically, or can "decline" to sign it altogether. In each case, the signer is prompted to provide a reason. That reason is saved in the package's list of messages.

The following code samples illustrate how to retrieve the opt-out or decline reason from a package.

Retrieving a Completion Report

A Completion Report contains information about: (1) a sender; (2) their packages with a specified status (e.g., DRAFT, SENT, COMPLETED).

Such a report can be retrieved via two alternative methods: (1) as a CompletionReport object; (2) in CSV format.

The following code samples illustrate how to retrieve a Completion Report using both methods.

Retrieving a Usage Report

A Usage Report contains: (1) a list of all senders on an account; (2) for each sender, the number of packages with each signing status (e.g., DRAFT, SENT, COMPLETED).

Such a report can be retrieved via two alternative methods: (1) as a UsageReport object; (2) in CSV format.

The following code samples illustrate how to retrieve a Usage Report using both methods.

Retrieving e-Notary Journal Entries

e-Notary Journal entries can be retrieved in either JSON format or CSV format. The following code samples illustrate how to do both.

Was this information helpful?
X