# SealingService v1
# Introduction
SealingService is a service with a SOAP web service interface and is used for sealing PDF documents.
The service may be used from any platform capable of making a SOAP web service call and relies on Signicat's standalone Session Data Storage (SDS) service for uploading and downloading binary document data.
# Location
The WSDL for the service is available at:
Infrastructure | Location |
---|---|
Pre-production | https://preprod.signicat.com/ws/sealingservice-v1?wsdl (opens new window) |
Production | https://id.signicat.com/ws/sealingservice-v1?wsdl (opens new window) |
Note
The only difference between the WSDL in pre-production and production is the SOAP address location attribute.
# List of methods
Method | Description |
---|---|
create-seal | Seals a specified document |
# create-seal
# Purpose
This method is used for sealing a document. The sealed document will be available for download in the SDS system when this method returns.
# Parameters
Name | Data type | Description |
---|---|---|
service | String | The name of the customer service (the customer account). |
password | String | The password for the service. This is different in pre-production and production. |
packaging-method | String | The name of the method to use when creating the seal. |
inputdocument | DocumentId | Specifies a document to be sealed. |
send-result-to-archive | Boolean | Specifies if the sealing result will be archived or not. Default is false , meaning that the sealing result will be saved temporarily in SDS; the ID in the return value will be an SDS id . If specified and set to true , the sealing result will be archived in Signicat's archive and the return value will be an archive id . |
# Return value
Name | Data type | Description |
---|---|---|
id | String | URL to the document package in SDS or to Signicat's archive if sendresulttoarchive is true |
error | Error | An error code and message |
# Data type: DocumentId
# Description
The DocumentId
data type is a reference to a document in the SDS system. A DocumentId
can be one of three data types that extend the general DocumentId
data type.
Each extension provides fields that identify the document in each target system.
# Extensions
Extension | Description |
---|---|
OrderDocumentId | A document that was created recently by the signature portal and is still available there. |
ArchiveDocumentId | A document in the archive |
SdsDocumentId | A document located in Signicat's standalone Session Data Storage (SDS). This is temporary storage that is accessible via a REST interface. |