Developers

An e-signature API you can build a product on

Create agreements, embed signing and react to events. The public REST API is fully described in OpenAPI 3.1, and a test fails our build when a route is left undocumented.

REST API v1

Documents, agreements from a document or template in one call, send, void and remind, signed PDF and certificate download, templates, webhooks and embedded signing.

/api/public/v1

Two ways to authenticate

Scoped API keys with expiry and embed origins, or an OAuth 2.0 server with authorization code and PKCE, client credentials, rotating refresh tokens, revocation and introspection.

ask_live_… · ask_test_…

Safe to retry

Send an Idempotency-Key and a repeated request is replayed for 24 hours instead of creating a duplicate. Cursor pagination and one standard error envelope throughout.

Idempotency-Key · X-RateLimit-*

Webhooks

Eleven events, delivered properly

Webhook deliveries are written to a transactional outbox in the same database transaction as the change they describe, so an event is never lost between “it happened” and “we told you”.

  • Signed payloads
  • Retries, and auto-disable for an endpoint that keeps failing
  • Delivery log, redelivery and a test ping

events11

  • agreement.sent
  • agreement.completed
  • agreement.declined
  • agreement.expired
  • agreement.voided
  • recipient.viewed
  • recipient.signed
  • recipient.declined
  • recipient.delegated
  • document.ready
  • document.failed

Embedded signing

Signing inside your own pages

Ask the API for a signing URL and put it in a frame. The signer never leaves your product.

  • Single-use URLs that expire after five minutes
  • postMessage events tell your page what the signer did
  • frame-ancestors restricted to origins you approve

The full developer feature list

API and authentication

  • Public REST API v1

    Documents, agreements from a document or template in one call, send / void / remind, signed PDF and certificate download, templates, webhooks and embedded signing, under /api/public/v1.

  • OpenAPI 3.1 specifications

    For the app API and the public API, with a test that fails when a route is undocumented.

  • API keys

    Live and test keys (ask_live_… / ask_test_…) with scopes, expiry, embed origins and last-used time. The secret is shown once.

  • OAuth 2.0 server

    Authorization code with PKCE, rotating refresh tokens with reuse detection, client credentials, revocation, introspection, RFC 8414 metadata and a consent screen.

  • Rate limits per credential and per plan

    With X-RateLimit-* headers so clients can back off politely.

  • Idempotency-Key support, cursor pagination and a standard error envelope

    Retry safely for 24 hours without creating duplicates.

Events and embedding

  • Signed webhooks for 11 events

    agreement.sent / completed / declined / expired / voided, recipient.viewed / signed / declined / delegated, document.ready / failed — with retries, auto-disable, a delivery log, redelivery and a test ping.

  • Embedded signing

    Single-use 5-minute URLs, postMessage events, and frame-ancestors restricted to approved origins.

  • Sandbox mode

    Emails are captured in a developer log and excluded from usage.

  • Developer settings with a self-hosted API reference

    Plus an integration guide with curl examples.

Building signing into a product?

Tell us what you are building. We will point you to the right endpoints and be clear about anything the API does not cover yet.