Skip to content
SealpostSealpostSealpost docs

Overview

API-first e-signature service.

Sealpost API 2026-10-22

Section titled “Sealpost API 2026-10-22”

The Sealpost REST API. Authenticate every call with a tenant API key as a bearer token. Keys are sk_live_… or sk_test_…; a test key only ever works in test mode, a live key may opt into test mode per request with the Sign-Test-Mode: true header (nothing is billed in test mode).

Every response carries Sign-Request-Id; quote it in support requests. Errors are RFC 9457 application/problem+json documents with a stable code from the catalogue in docs/errors.md.

This revision covers the SG-01 surface (ping, me, API keys, request log, the spec itself) and SG-02: files and the creation of draft envelopes with recipients and fields by coordinates. Sending, templates and webhooks follow.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/ping
GET
/me
GET
/openapi.json
GET
/api-keys
POST
/api-keys
DELETE
/api-keys/{id}
POST
/api-keys/{id}/rotate
GET
/requests
POST
/files
POST
/files/presign
GET
/files/{id}
POST
/files/{id}/complete
POST
/envelopes
GET
/envelopes/{id}

Authentication

Section titled “Authentication”

ApiKey

Section titled “ApiKey”

Authorization: Bearer sk_test_…. Keys are created with bin/console tenants:create (the first pair) or POST /api-keys.

Security scheme type: http

Bearer format: sk_live_… or sk_test_…