Signature Requests

A signature request is a signing transaction created through the API. It combines templates, signers and configuration into a single sendable workflow.

What a signature request contains

A signature request can include:

• mode: how the request is delivered
• message: the message signers see
• templates: one or more templates to send
• Optional sequential_signing: signing order configuration
• Optional field_visibility: field visibility configuration
• Optional external_id: associate with an internal record
• Optional metadata: additional application context
• Optional webhook: webhook configuration

The supplied schema requires mode, message and templates.

Request structure

SignatureRequest
  ├── templates[]
  │    └── TemplateRequest
  │          └── signers[]
  │                └── Signer
  ├── metadata
  └── webhook

Creating a request

Create a signature request with POST /signature-requests. A successful create returns a package_id and package_guid, store both with your internal record.

Tracking a request

Retrieve status with GET /signature-requests/{package_guid}, which returns overall status, per-signer status and assigned documents. For event-driven tracking, configure a webhook.

Related