Sealsimple
Start free
Developers

Sealsimple REST API

Create, send and track documents for signature from your own software. Version 1, JSON over HTTPS.

Authentication

Live keys are included in Pro; test keys work on every plan, Free included (see Test mode). A workspace owner or admin creates a key in the app under Settings & branding → API keys. Keys look like sk_live_ (or sk_test_) followed by 40 characters and are shown once. Send it with every request:

Authorization: Bearer sk_live_…

A key belongs to one workspace and only sees that workspace's documents. It acts as the person who created it, and stops working when it's revoked, when that person is no longer an owner or admin, or, for a live key (with 402), when the workspace no longer has Pro. Everything a key changes is written to the document's audit trail as api:<key name>.

Base URL: https://sealsimple.com/api/v1. Errors are JSON: {"error": "code", "message": "text"}.

Test mode

Try the whole flow without Pro and without emailing anyone: create a test key (sk_test_…) under Settings & branding → API keys. Test keys work on every plan. Everything else works as with a live key, with these differences:

  • A test key only sees and makes test documents, and a live key never sees them. Each has "test": true and a delete_after date.
  • Nobody is emailed: not the signers, not the copy recipients, not you. Once a test document is sent, every signer gets a signing_url: open it to sign as that signer. It opens without a code. remind returns "emailed": 0.
  • The signing page and every page of the signed PDF are marked TEST. A test signature isn't valid.
  • Test documents don't count toward the free plan's monthly documents, don't send webhook events, and are deleted 7 days after they were made.
  • In the app they appear in your Documents list with a TEST badge.
{ "id": "3f6c…", "test": true, "status": "sent", …,
  "signers": [{ "name": "Ana Jansen", "status": "pending", …,
    "signing_url": "https://sealsimple.com/sign/…" }],
  "delete_after": "2026-11-23T10:00:00.000Z" }

Ready for real documents? Create a live key on Pro and change nothing else in your code.

Endpoints

POST/api/v1/documents

Uploads a file and creates a document. Send multipart/form-data with a file part and a JSON data part, or application/json with file_base64 and filename next to the other fields. PDF, PNG and JPEG up to 25 MB (images become a one-page PDF; Word files must be saved as PDF first).

  • signers (required): [{"name", "email", "order"?}], up to 20.
  • title: defaults to the file name. cc: [{"name", "email"}], people who get a copy.
  • message (max 2000), subject (max 200): the invitation email.
  • deadline: ISO 8601 date-time, at least an hour away. signing_order: true to sign one after another (by order).
  • language: the signers' language, e.g. en, nl, fr, de.
  • auto_place_fields (default true): places fields like Place fields automatically in the editor. Signers without a field (or all, with false) get a signature, name and date at the end of the last page.
  • send (default false): send right away. If sending is refused, the draft stays and the error names its id.
curl https://sealsimple.com/api/v1/documents \
  -H "Authorization: Bearer $SEALSIMPLE_KEY" \
  -F file=@contract.pdf \
  -F 'data={"title":"Service agreement","signers":[{"name":"Ana Diaz","email":"ana@client.com"}],"send":true}'

Returns 201 with the document:

{
  "id": "3f6c…", "title": "Service agreement", "status": "sent",
  "signing_order": false, "message": null, "deadline": null,
  "created_at": "2026-11-12T10:00:00Z", "sent_at": "2026-11-12T10:00:01Z", "completed_at": null,
  "signers": [{ "id": "a1b2…", "name": "Ana Diaz", "email": "ana@client.com", "order": 1,
                "status": "pending", "viewed_at": null, "signed_at": null, "declined_reason": null }],
  "cc": [],
  "urls": { "self": "https://sealsimple.com/api/v1/documents/3f6c…", "app": "https://sealsimple.com/documents/3f6c…",
            "audit": "https://sealsimple.com/api/v1/documents/3f6c…/audit", "signed_pdf": null }
}
POST/api/v1/documents/{id}/send

Sends a draft, with the same checks as the app (a confirmed sender address, every signer has a field, no placeholder addresses, a deadline in the future). Returns the document.

curl -X POST https://sealsimple.com/api/v1/documents/$ID/send -H "Authorization: Bearer $SEALSIMPLE_KEY"
GET/api/v1/documents/{id}

The document with its status (draft, sent, viewed, partially_signed, completed, declined, voided, expired), each signer's status with when they opened and signed it, and the created, sent and completed dates.

curl https://sealsimple.com/api/v1/documents/$ID -H "Authorization: Bearer $SEALSIMPLE_KEY"
GET/api/v1/documents?status=&limit=&cursor=&updated_after=&sort=

Documents of the workspace, newest first. limit 1–100 (default 25), optional status. Pass next_cursor as cursor for the next page; it's null on the last page.

Changes since a moment (for polling): updated_after (ISO 8601) lists only documents that changed after it, most recently changed first. Every document has an updated_at, which moves when its status changes (sent, opened, signed, completed, declined, expired, cancelled). sort=updated_at or sort=created_at (default) sets the order.

curl "https://sealsimple.com/api/v1/documents?status=completed&limit=50" -H "Authorization: Bearer $SEALSIMPLE_KEY"

{ "data": [ …documents… ], "next_cursor": "MjAyNi0xMS0x…" }

# Everything that changed since your last poll
curl "https://sealsimple.com/api/v1/documents?updated_after=2026-11-16T10:00:00Z" -H "Authorization: Bearer $SEALSIMPLE_KEY"
GET/api/v1/documents/{id}/signed.pdf

The sealed PDF with the signatures and the certificate. 404 not_completed until everyone has signed.

curl -o signed.pdf https://sealsimple.com/api/v1/documents/$ID/signed.pdf -H "Authorization: Bearer $SEALSIMPLE_KEY"
GET/api/v1/documents/{id}/audit

The audit trail, oldest first: {"document_id", "events": [{"id", "type", "actor", "recipient_id", "ip", "user_agent", "meta", "created_at", "hash"}]}.

curl https://sealsimple.com/api/v1/documents/$ID/audit -H "Authorization: Bearer $SEALSIMPLE_KEY"
POST/api/v1/documents/{id}/remind

Emails a reminder to every signer whose turn it is. Returns {"reminded": 1, "emailed": 1}.

curl -X POST https://sealsimple.com/api/v1/documents/$ID/remind -H "Authorization: Bearer $SEALSIMPLE_KEY"
POST/api/v1/documents/{id}/cancel

Cancels a draft or a document out for signing. The optional reason (max 500) is shown to the signers. Completed documents can't be cancelled. Returns the document.

curl -X POST https://sealsimple.com/api/v1/documents/$ID/cancel \
  -H "Authorization: Bearer $SEALSIMPLE_KEY" -H "Content-Type: application/json" \
  -d '{"reason":"Replaced by a new version"}'

Errors

StatuserrorWhen
401invalid_api_keyNo key, a malformed key, an unknown or revoked key, or its creator is no longer an owner or admin.
402pro_requiredA live key, and the workspace isn't on Pro (or Pro ended). Test keys work on every plan.
403live_key_requiredA test key on /webhooks: subscriptions need a live key.
404not_foundNo such endpoint, or no such document in the key's workspace.
404not_completedsigned.pdf before everyone has signed.
405method_not_allowedWrong HTTP method for this path.
409too_many_webhooksThe workspace already has 10 webhooks.
409invalid_stateThe document isn't in a state that allows this (e.g. sending a document that was already sent).
413file_too_largeThe file is over 25 MB.
415unsupported_file_type / unsupported_media_typeNot a PDF, PNG or JPEG, or the body isn't multipart/form-data or JSON.
422invalid_urlThe webhook URL isn't https, isn't public or doesn't resolve.
422validation_errorA field is missing or invalid; the message says which.
422invalid_pdf / invalid_fileThe file is password-protected, encrypted or broken.
422placeholder_emailA recipient still has an @example.com address.
422request_failedSending was refused by one of the app's checks (the message explains, e.g. a confirmed sender address is needed).
429rate_limitedMore than 60 requests in a minute with this key. Wait for the Retry-After header's seconds.
500internal_errorSomething went wrong on our side. Try again.

Rate limits

60 requests per minute per key. Over the limit you get 429 rate_limited with a Retry-After header in seconds. Uploads are limited to 25 MB, 20 signers and 20 copy recipients per document.

Webhooks

Rather than asking for a document's status again and again, let Sealsimple tell you: a webhook posts a signed message to your URL when a document is sent, opened, signed, completed, declined, expired or cancelled. Documents created through the API send the same events; test documents send none. Add one in Settings & branding → Integrations, or with the API below. The message format and how to check the signature: Send document events to your system with webhooks.

Manage webhooks via the API

For integrations that subscribe and unsubscribe themselves (Zapier, Make, n8n and your own). These are the same webhooks as in Settings & branding → Integrations: at most 10 per workspace, https URLs that are reachable from the internet, Pro. They need a live key: test keys get 403 live_key_required, because test documents send no events.

POST/api/v1/webhooks

JSON body: url (required), events (optional, default all: document.sent, document.viewed, document.signed, document.completed, document.declined, document.expired, document.canceled), description (optional, max 100). Returns 201 with the webhook and its signing secret, shown once here.

curl -X POST https://sealsimple.com/api/v1/webhooks \
  -H "Authorization: Bearer $SEALSIMPLE_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://hooks.example.com/sealsimple","events":["document.completed"]}'

{ "id": "8d2e…", "url": "https://hooks.example.com/sealsimple", "description": "API: CRM integration",
  "events": ["document.completed"], "status": "active", "created_at": "…", "secret": "whsec_…" }
GET/api/v1/webhooks

The workspace's webhooks, without secrets: {"data": [ …webhooks… ]}. status is active, disabled (switched off in the app) or failing (switched off by us after too many failed deliveries).

GET/api/v1/webhooks/{id}

One webhook, or 404.

DELETE/api/v1/webhooks/{id}

Deletes it, with its delivery history. Returns {"id": "…", "deleted": true}.

curl -X DELETE https://sealsimple.com/api/v1/webhooks/$WEBHOOK_ID -H "Authorization: Bearer $SEALSIMPLE_KEY"

Accounting & invoicing workflow

Test sending a quote or invoice from your accounting or ERP software. Set SEALSIMPLE_TEST_KEY to your sk_test_… key and replace <YOUR_TEST_EMAIL> with an email address you control. Placeholder addresses such as example.com fail validation. Test mode sends no email.

  1. Upload a test PDF and add yourself as the signer: call POST /documents with file (or file_base64) and signers.
  2. Place fields automatically: keep auto_place_fields: true (the default) to find signing fields in the PDF. If no fields are found for a signer, Sealsimple adds signature, name and date fields for that signer on the last page.
  3. Send and sign in test mode: verify the sender email address on your Sealsimple account before sending, even in test mode. Pass "send": true on create, or call POST /documents/{id}/send. Save the returned id and open the signer's signing_url to complete the test signature.
  4. Check completion: call GET /documents/{id} with the same test key and check for "status": "completed".
  5. Download the test PDF: call GET /documents/{id}/signed.pdf once everyone has signed.
# Quickstart with a free test key (sk_test_…)
curl -X POST https://sealsimple.com/api/v1/documents \
  -H "Authorization: Bearer $SEALSIMPLE_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Quote #2026-041",
    "filename": "quote-2026-041.pdf",
    "file_base64": "<BASE64_PDF>",
    "signers": [{ "name": "Test signer", "email": "<YOUR_TEST_EMAIL>" }],
    "language": "en",
    "send": true
  }'

Production webhooks. Test documents do not emit webhook events. For live documents, subscribe to document.completed in Settings & branding → Integrations or via POST /webhooks with a live API key. Webhooks require Pro (€9/month). Live API keys require Pro + the API add-on (€10/month excl. VAT per 500 live requests per 7 days).