Introduction
Envelopes
Recipients
Deliverables
Copy
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json
{
"type": "standard"
}
Copy
// HTTP Status Code 201
{
"id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
"name": null,
"envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
"type": "standard",
"status": "processing",
"url": null,
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum"],
"password": null,
"created_at": "2024-01-01T00:00:00Z",
"generated_at": null
}
Deliverables
Create a deliverable
Creates a new deliverable from a completed envelope.
POST
/
v1
/
envelopes
/
{envelope_id}
/
deliverables
Copy
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json
{
"type": "standard"
}
Copy
// HTTP Status Code 201
{
"id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
"name": null,
"envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
"type": "standard",
"status": "processing",
"url": null,
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum"],
"password": null,
"created_at": "2024-01-01T00:00:00Z",
"generated_at": null
}
Creates a new deliverable from a completed envelope. The envelope must have a
status of completed.
SignatureAPI already creates one deliverable automatically when an envelope completes. Use this endpoint to generate additional deliverables after that point. For example, create a simple deliverable containing only specific documents, or a password-protected copy for secure distribution.
The deliverable starts in processing status and transitions to generated once the PDF is ready. This usually takes a few seconds. Subscribe to the deliverable.generated webhook to be notified when the deliverable is ready for download.
Deliverables created using this endpoint are not sent automatically to recipients.
Path Parameters
The unique identifier of the envelope, in UUID format.
Body Parameters
Show Standard Deliverable
Show Standard Deliverable
The standard deliverable includes an audit log. To get signed documents without an audit log, use the simple deliverable instead.
A user-provided name for this deliverable. Use this to identify deliverables when an envelope has more than one.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Between 1 and 32 characters.
The type of the deliverable.
standard: Includes the signed documents and an audit log with a certificate of completion. This is the default.simple: Includes the signed documents only, without an audit log.
standard.The language for system-generated text in the audit log, including labels and the certificate of completion. Does not affect the content of the signed documents.Supported values:
en (English), es (Spanish), fr (French), it (Italian), pt (Portuguese), de (German), zh (Chinese Simplified), hu (Hungarian).Defaults to the envelope language.The timezone used for timestamps in the audit log. Must be a valid IANA Time Zone Database identifier (e.g.,
America/New_York, Europe/London). Does not affect timestamps inside the signed documents.Defaults to the envelope timezone.The format for timestamps in the audit log. Uses MomentJS format tokens (e.g.,
MM/DD/YYYY HH:mm:ss). Does not affect timestamps inside the signed documents.Defaults to the envelope timestamp format.The keys of the documents to include in the deliverable. By default, all documents in the envelope are included.Use this to create a deliverable with only a subset of documents. For example, generate separate deliverables for different recipients. Accepts between 1 and 10 document keys.
The password used to encrypt the deliverable. Recipients must enter this password to access the downloaded file.Password requirements:
- Between 4 and 32 characters
- Letters and numbers only (no special characters or spaces)
********).Password protection is available upon request. Contact support to enable this feature.
Show Simple Deliverable
Show Simple Deliverable
The simple deliverable does not include an audit log. To get signed documents with an audit log, use the standard deliverable instead.
A user-provided name for this deliverable. Use this to identify deliverables when an envelope has more than one.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Between 1 and 32 characters.
The type of the deliverable.
standard: Includes the signed documents and an audit log with a certificate of completion. This is the default.simple: Includes the signed documents only, without an audit log.
simple.The keys of the documents to include in the deliverable. By default, all documents in the envelope are included.Use this to create a deliverable with only a subset of documents. For example, generate separate deliverables for different recipients. Accepts between 1 and 10 document keys.
The password used to encrypt the deliverable. Recipients must enter this password to access the downloaded file.Password requirements:
- Between 4 and 32 characters
- Letters and numbers only (no special characters or spaces)
********).Password protection is available upon request. Contact support to enable this feature.
Returns
Returns a201 Created status code along with a deliverable object after successful creation, or an error otherwise.
Copy
Ask AI
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json
{
"type": "standard"
}
Copy
Ask AI
// HTTP Status Code 201
{
"id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
"name": null,
"envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
"type": "standard",
"status": "processing",
"url": null,
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum"],
"password": null,
"created_at": "2024-01-01T00:00:00Z",
"generated_at": null
}
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.