link

# ArchiveService v3

# Introduction

The ArchiveService API can be used to access documents that are stored in Signicat's archive.

All documents in the archive are identified with a unique archive reference. The archive reference is necessary to access the document. Documents have no metadata and there is no functionality for searching for documents.

# Location

The WSDL for the service is available at:

Infrastructure Location
Pre-production https://preprod.signicat.com/ws/archiveservice-v3?wsdl (opens new window)
Production https://id.signicat.com/ws/archiveservice-v3?wsdl (opens new window)

# List of methods

Method Description
getDocument https://preprod.signicat.com/ws/archiveservice-v3?wsdl (opens new window)
removeDocument https://id.signicat.com/ws/archiveservice-v3?wsdl (opens new window)

# Mandatory parameters in all requests

All requests require these mandatory parameters for authentication.

Name Data type Description
version String Should be 3.0.
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.

# getDocument

# Purpose

This method is used for retrieving a document from the archive.

# Parameters

Name Data type Description
archive-id String Unique archive identifier. Identifies the document to be retrieved.

# Return value

Name Data type Description
archive-id String Unique archive identifier. Identifies the document to be retrieved.
mime-type String The document's MIME type.
data Base64 Base64-encoded binary data. This is the document.

# removeDocument

# Purpose

This method is used for removing a document from the archive. The service will try to remove all documents in the input list. The return value will list all documents that were successfully removed.

Important

This method will accept an archive-id that does not exist. In the case of failure, this method call can be repeated with the same input.

# Parameters

Name Data type Description
archive-id List of String A list of unique archive-ids for the documents to be removed.

# Return value

Name Data type Description
archive-id List of String A list of unique archive-ids for the documents that were successfully removed.
Last updated: 7/21/2021, 1:18:18 PM