Start here
Concepts
The building blocks of SignatureAPI: envelopes hold documents and recipients, places mark where to sign, and deliverables return the signed files.
SignatureAPI organizes the document signing process around a few core concepts. An envelope holds documents and recipients. Places on each document say what each recipient fills in. Each recipient acts in a ceremony, and the completed envelope produces a deliverable.
Produced when the envelope completes.
Diagram as text
Parts
- Envelope: The container for documents and recipients. Produces the deliverable when it completes.
- Document: A PDF or DOCX file inside the envelope. Holds the places.
- Recipient: A person or automatic signer who acts on the envelope.
- Place: A region on a document. Most places name the recipient who fills them in recipient_key.
- Ceremony: The session where a recipient reviews the documents and fills their places.
- Deliverable: The signed documents and the audit log.
Connections
- Envelope to Document: contains
- Envelope to Recipient: contains
- Document to Place: has
- Place to Recipient: assigned to
- Recipient to Ceremony: signs in
- Envelope to Deliverable: produces
| Part | What it is |
|---|---|
| Envelope | The container for documents and recipients. It tracks the signing workflow from creation to completion. |
| Document | A PDF or DOCX file inside the envelope, provided as is or generated from a template. |
| Place | An interactive region on a document, such as a signature or a text input. Most places are assigned to one recipient. |
| Recipient | A person or automatic signer who acts on the envelope. |
| Ceremony | The session where a recipient reviews the documents and completes their places. |
| Deliverable | The signed documents and the audit log, produced when the envelope completes. |
Envelope
An Envelope is a container that holds documents and recipients. It organizes and tracks the entire signing workflow from creation to completion.
Documents
Documents are the files within an envelope that recipients need to review and sign. You can provide PDFs directly or generate documents from templates with dynamic data.
Each document has places: the regions where a recipient signs, initials, or enters information. A place’s recipient_key names the recipient who completes it. A text place shows fixed text and has no recipient.
Recipients
Recipients are the people who interact with the envelope. Each recipient has a type (signer, approver, preparer, automatic signer, or qualified signer) that determines what actions they can perform.
Ceremony
A Ceremony is a guided session in which a recipient reviews the documents and performs their required actions, such as signing. Each recipient completes their own ceremony, and you can control the signing order (parallel or sequential).
Deliverable
After all recipients have completed their actions, the envelope is completed. A Deliverable is then generated, containing the signed documents and an audit log. The deliverable is sent to the recipients and is available for download via the API.