Installation

Use the Magenta Security Sign Client to integrate with Magenta Security Sign. Using the Client ensures that your documents are processed locally and are never sent in clear text.

Requirements

The Magenta Security Sign Client is distributed as an executable file compatible with recent Linux, Windows and macOS operating systems and can be run in a Docker container.

The Client requires access to the Magenta Security Sign API and an authentication token for most of its commands.

When running the Client as a Local API, the executable will listen to HTTP ports which must be accessible to client applications.

How to install

Download Magenta Security Sign Client from our Downloads page.

Usage

You can use the Magenta Security Sign Client as a Local API or as a CLI. In both cases, you will be able to sign one or more documents and invite external signers.

Using the Client as a Local API

Just want to try the Local API? Skip to the Local API Quickstart.

In this scenario, you will start the Local API, either directly in a node or VM, or inside a Docker container. The Client will use HTTP to sign documents with the guarantee that documents do not leave the local environment. This is the best option for centralized document signatures where documents are signed during an automated document workflow.

Using the client as command line interface

Just want to try the CLI? Skip to the CLI Quickstart.

Use the Client as a command line interface (CLI) for desktop automation or to integrate Magenta Security Sign in a standalone application.

Standalone applications can directly call the Magenta Security Sign executable to sign documents or request signatures from other people.

Documents can either be saved and loaded on the file system, or they can be passed to the command using the standard input and output.