API

Appearance

Getting started ​

Use the Upsign API to create document drafts, manage signing workflows, and automate document lifecycle events from your application. This guide walks through the core integration flow—from configuring API access to receiving signed webhook events.

Quickstart ​

Most integrations follow the same core workflow:

API endpoint ​

All API requests are made relative to the /v2 API endpoint.

https://api.upsign.com/v2

Generate API key ​

Upsign authenticates API requests with an API key in the X-Api-Key header.

  1. In Upsign, open Settings → Integrations → API Access.
  2. Click Generate new API key.

WARNING

Store API keys securely on your server and never expose them in client-side applications.

Required headers ​

  • X-Api-Key: required for authenticated requests
  • X-Partner-User-Id: required for mutating requests (POST, PUT, PATCH, DELETE) to attribute actions to an end-user
  • X-Partner-User-Email: optional end-user email for attribution/logging
  • X-Partner-Request-Id: optional request id for idempotency/tracing

Start a document workflow ​

Start a document workflow from your application by creating a draft through the Upsign API. Drafts can include uploaded files and optional recipient configuration before continuing the signing workflow in Upsign.

Create document draft API reference

Monitor document status ​

Upsign uses signed webhook events to notify your application about document lifecycle changes in real time. Most integrations use webhooks to track status updates, trigger downstream workflows, and keep systems synchronized.

Webhooks overview

Webhook subscriptions can be configured through the Upsign dashboard or the admin webhook API endpoints.

Send reminders to recipients ​

Trigger reminder emails for recipients who have not yet completed signing on documents that are currently out for signature.

Send reminder API reference

Reminders can only be sent for documents with an OUT_FOR_SIGNATURE status.

Next steps ​