Skip to content

Start here

SignatureAPI Docs

Add electronic signatures to your app with the SignatureAPI REST API: send envelopes, embed signing on web and mobile, and get webhook events.

Integrate electronic signatures into your apps and workflows with SignatureAPI.

Get started

What you can do

See all capabilities

How it works

Your backend creates envelopes with the API. Each recipient signs in a ceremony, from the signing email or embedded in your app. Webhooks tell your backend when something changes.

How SignatureAPI fits in your stack
How SignatureAPI fits in your stack6 parts: Your backend, Webhook endpoint, API, Envelope, Event, Ceremony. Connections: Your backend to API (HTTPS requests); API to Envelope (creates); Envelope to Ceremony (signing link); Envelope to Event (status changes); Event to Webhook endpoint (webhooks).Your systemsSignatureAPIYour recipientsYour backendWebhook endpointAPIEnvelopeEventCeremonyHTTPS requestscreatessigning linkstatus changeswebhooks
Your systemsSignatureAPIYour recipientsSignatureAPI (continued)Your systems (continued)Your backendAPIEnvelopeCeremonyEventWebhook endpointHTTPS requestscreatessigning linkstatus changeswebhooks

Asynchronous: SignatureAPI calls your endpoint when something changes.

Diagram as text

Parts

  • Your backend: Holds the API key and creates envelopes.
  • Webhook endpoint: Receives events and verifies their signatures.
  • API: Checks the API key in X-API-Key and validates each request.
  • Envelope: Holds the documents and recipients and moves through its lifecycle.
  • Event: Records each status change of an envelope, recipient or deliverable.
  • Ceremony: Opened from the signing email or embedded in your app.

Connections

  • Your backend to API: HTTPS requests
  • API to Envelope: creates
  • Envelope to Ceremony: signing link
  • Envelope to Event: status changes
  • Event to Webhook endpoint: webhooks
1

Create an envelope

An envelope holds your documents and recipients. Add documents directly as PDFs or generate them from templates.

POST /v1/envelopes HTTP/1.1
Host: api.signatureapi.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json

{
  "title": "Service Agreement",
  "message": "Please review the agreement and provide your signature.",
  "routing": "parallel",
  "documents": [
    {
      "key": "service_agreement",
      "title": "Service Agreement",
      "url": "https://pub-9cb75390636c4a8a83a6f76da33d7f45.r2.dev/docs-samples/acme-service-agreement.pdf",
      "format": "pdf",
      "places": [
        {
          "key": "client_signs_here",
          "type": "signature",
          "recipient_key": "client"
        },
        {
          "key": "provider_signs_here",
          "type": "signature",
          "recipient_key": "provider"
        }
      ]
    }
  ],
  "recipients": [
    {
      "type": "signer",
      "key": "client",
      "name": "Jane Doe",
      "email": "jane.doe@example.com"
    },
    {
      "type": "signer",
      "key": "provider",
      "name": "John Smith",
      "email": "john.smith@example.com"
    }
  ]
}
2

Recipients receive a signing link

Each recipient gets a link to review and sign. You can control the signing order and authenticate recipients before they access the documents.

Signing request email naming the sender and the envelope title, with a View and Sign button and the sender's message
Signing request email
3

Recipients sign during a ceremony

A ceremony is the guided signing session where recipients review documents and complete their actions.

Signing ceremony with the document open, the test-mode notice at the top of the page, and the Start button
Signing ceremony
4

Retrieve the signed deliverable

After all recipients complete their actions, SignatureAPI generates a deliverable containing the signed documents and an audit log.

Sample audit log with the envelope details at the top, the list of events, and the agreed text under each consent event
Audit log, first page

Explore