|
The following web services are available from the SmartSAFE:
Document Tagging Web Services:
Preparation of documents for signing can be completed via SmartConnect for the
following signing methods:
- SmartSignature (TagTool.dll)
- SmartSignature Server (Tagging API)
- SmartSigning Room
Folder Level Web Services
- Search Folder: Searches for folder in the SmartSAFE.
- Get Folder: Returns information about a given folder.
- Get Root Folder: Returns the root folder from SmartSAFE’s Folder Explorer. This works in conjunction with Get Child Folders.
- Get Child Folder: Returns the child folder for a Root Folder in Folder Explorer. This method is useful for building trees. For example, this method could be used to build the complete folder tree so a folder can be selected for upload.
- Add Folder: Creates a new folder underneath the given parent folder.
- Get Documents: Returns a list of documents in a given folder.
Document Level Web Services:
- Upload Document: Securely uploads a document or series of documents to the SmartSAFE.
- Search Document: Searches for a document within the SmartSAFE.
- Upload ePackage: Uploads a document for filing, preparation for signing and SmartSigning Room creation.
- Get Document Properties: Returns the properties for a given document.
- Get Document Signers: Returns the signers of a particular document.
- Get Signed Document: Returns a copy of the document as a byte array.
- Get WSOL/SOL Export Package: Returns export package containing SOL/WSOL file and package hash for a specific document.
- Get Package Hash: Returns hash of export package for Client to verify package has not been tampered with since original export.
- Confirm Export Package: Records successful export and deletes the exported document at the SmartSAFE (if applicable.)
- Delete Partially Signed Document: Allows incomplete signings to be deleted from SmartSAFE.
- Delete Document: Allows signed documents to be deleted from SmartSAFE
(with appropriate permissions and settings.)
- Get Signed Document with Graphic: Returns XML containing the signed document (with footer and/or watermark information if applicable) and signer graphics.
Admin & Reporting Web Services:
- Create Account: Creates new user accounts for signing and SmartSAFE access.
- Change User Password: Allows authorized users to change current password.
- Admin Change Password: Resets the SmartSAFE Admin password.
- Batch Processing Request: Allows for batch processing of user accounts.
- Set User Profile: Updates an existing users’ profiles.
- Set Configuration Settings: Updates SmartSAFE configuration settings, including:
— Deletion of signed documents settings
— Document Export (SOL/WSOL) configuration settings,
— Footer and / or Watermark settings
— Signer graphic configuration
- Signing Status Report: Allows Signing Status Report to be pulled, providing the status of documents prepared for signing.
- Add Client: Adds a new SmartSAFE client.
- Signing Room Details: Allows Signing Room Details report to be pulled, providing details on signing room completion.
- Signing Room Log: Allows Signing Room log to be pulled, providing details on signing room activity.
- Get Field Length: Retrieves a Client's username and password maximum/minimum settings.
- Authenticate: Authenticates user and returns a Session ID.
Export Utility Methods:
A series of web methods to extract information from a WSOL/SOL export package.
- Get File: extracts SOL/WSOL file
- Get Signer Graphic: extracts signer graphic
- Get Signed Document: extracts signed document
- Get Document Name: extracts document name
- Get Signer Details: extracts all signer details
— WSOL files: Signer first/last name; date/time stamp
— SOL files: Signer first/last name; date/time stamp; certificate revocation and validity details
- Get Certificate Details: extracts certificate revocation and validity details for the tamper evident seal of the WSOL package
|