The Signicat Archive API ensures long‑term integrity, legal compliance and easy access to signed and other documents requiring secure, tamper‑proof retention.
If you are an existing customer of our Sign API v2, see our documentation on archive functionality within our Sign API v2.
Use cases
- Object submission
- Object archiving
- Tagging of archived objects
- Searching for archived objects
- Retrieval of archived objects
- Updating of archived objects
- Object reports
- Object audit logs via API
- Retention management
Set up an API integration
Setting up an API integration is the most flexible way of testing our solutions. You can use your preferred IDE, framework, Postman, etc. using credentials provided by Signicat.
Before you set up an API integration, we recommended that you familiarise yourself with the OpenAPI reference documentation to learn about available endpoints and their properties.
Prerequisites
Before you can start making requests to this API, you need to learn how to connect to it. To do this, follow steps 1-3 in the Connect to Signicat APIs Quick start guide.
Using the API
The Signicat Archive API allows you to create and manage archive records. Building a document archiving flow through your chosen system, for example our Sign API v2 documentation, consists of the following steps:
- Upload a document via our Sign API v2 by making a POST request to the Documents endpoint.
- Manage the document, including signing, where required.
- Automatically archive the document to the Signicat Archive after your work with the document is completed.
- Select the document retention period.
- Add tags to the document.
- Search for the document by name, date or tags.
- Retrieve the document from the archive when need.
- Extract the document report to view the audit log.
- Schedule your document for automatic deletion at the end of the retention period.
API reference
In our Signicat Archive API reference, you can find information about the available endpoints and properties, as well as sample requests and responses.
Other integration details
- The Signicat Archive API is a REST-based API solution built on top of Signicat's Digital Trust Platform (DTP) Archive. When a file is uploaded, it is packaged into an object that includes the file itself along with its associated metadata, such as the object ID, tags and audit logs. This object model ensures consistent structure and traceability for every stored item.
- The Signicat Archive API routes each object to the Digital Trust Platform Archive for persistent storage. Signicat's Digital Trust Platform Archive is the system of record where all objects are managed, indexed and maintained according to internal platform standards.
- The archived objects can be accessed and managed following the standard Signicat client API procedure:
- Get your client credentials.
- Set permissions.
- Obtain an access token.
- Make an API request.
- Signicat's Digital Trust Platform is hosted on Google Cloud Platform (GCP), which serves as the final storage destination. All archived objects are ultimately stored in GCP-managed infrastructure, leveraging its scalability, durability and security capabilities.