Public API

Autosignly has a REST API you can call from your own code: upload a PDF, attach files to it, send it to signers and download the sealed document when everyone has signed.

Base address:

https://app.autosignly.eu/api/publics/v1

Keys and environments

Every request carries two headers:

X-API-KEY:    api_key_...
X-API-SECRET: ...

Keys are created in Autosignly under API in the menu, where you will also find your webhooks and a log of the requests you have made.

Each environment has its own pair: production keys start with api_key_, sandbox keys with sbx_key_. The key alone decides which data you touch, so a sandbox key can never reach production documents. Not sure which one you are holding? Ask the API:

curl https://app.autosignly.eu/api/publics/v1/credentials \
  -H "X-API-KEY: $AUTOSIGNLY_API_KEY" \
  -H "X-API-SECRET: $AUTOSIGNLY_API_SECRET"

What you can do

• Documents — upload a PDF, list and filter documents, read one with its signers, download its file at any point (a document being signed carries the signatures collected so far)
• Attachments — attach PDF, JPEG and PNG files to a document before it goes out; they are converted to PDF and merged behind an index page listing each one with its checksum, so a single signature covers the document and everything attached to it
• Signing — send a document to signers with SES, AES or QES; the first signer gets a link immediately, the rest are e-mailed theirs when their turn comes
• Tags — group documents, and filter the listing by one or more tags
• Parties — keep the businesses and people you sign with: create, list and filter them by name or type, read one, replace it, remove it
• Webhooks — every asynchronous event (a signature, a completed document, a cancellation or a restore) is delivered to your endpoint, signed so you can verify it came from us. Event payloads and HMAC headers are in that page and in the OpenAPI webhooks section.

Clients

You can call the API with plain HTTP, or use one of the official clients — all Apache-2.0 and developed in the open at github.com/16it-pl/autosignly-sdk.

	Package	Page
Java	eu.autosignly:autosignly-client	Java client
Node.js	@16it/autosignly	Node client
Python	autosignly	Python client
CLI	autosignly	Command line tool

Versions: the supported line is 1.0.*. The newest release of each package is listed among the tags in the repository.

Prefer to read the API itself? Swagger UI lists every endpoint with its parameters and responses and lets you fire a call with your own key; the OpenAPI specification it serves is there to download if you would rather generate your own client.