Introduction
Envelopes
Recipients
Places
Deliverables
Copy
Ask AI
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
{
"type": "standard",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
Copy
Ask AI
// 201 Created
{
"id": "del_3gGNgIxxxxo8Xn7epZQ8F",
"name": null,
"envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
"type": "standard",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum", "exhibit_a"],
"password": null,
"status": "processing",
"url": null,
"created_at": "2025-12-31T23:59:59.999Z",
"generated_at": null
}
Deliverables
Create a deliverable
Creates a deliverable for a completed envelope.
POST
/
v1
/
envelopes
/
{envelope_id}
/
deliverables
Copy
Ask AI
// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
{
"type": "standard",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
Copy
Ask AI
// 201 Created
{
"id": "del_3gGNgIxxxxo8Xn7epZQ8F",
"name": null,
"envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
"type": "standard",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum", "exhibit_a"],
"password": null,
"status": "processing",
"url": null,
"created_at": "2025-12-31T23:59:59.999Z",
"generated_at": null
}
This operation creates a deliverable for a completed envelope.
Deliverables created using this endpoint are not sent automatically to the recipients.
Path Parameters
The unique identifier of the envelope.
Body Parameters
Show Standard Deliverable
Show Standard Deliverable
The Standard Deliverable includes the signed documents along with an audit log. If you just need the signed documents, use the Simple Deliverable instead.
A user-provided name for this deliverable. Must contain only lowercase letters, numbers, and underscores, and start with a letter. Helpful to identify its changes via events.
The type of the deliverable.Available options are
standard and simple. The default is standard.standard: Includes all documents and an audit logsimple: Includes only the documents without an audit log
standard.The language for the deliverable. This setting determines the language of system-generated text and additional documents, such as the audit log. It does not affect the language of the signed documents.Refer to the list of available languages. By default, the language is set to match the language specified in the envelope.
The time zone for the deliverable. This setting determines the time zone used in system-generated documents, such as the audit log. It does not affect the times shown inside the signed documents.Refer to the list of available time zones. By default, the time zone matches the time zone specified in the envelope.
The timestamp format for the deliverable. This setting determines the format of timestamps used in system-generated documents, such as the audit log. It does not affect the timestamps shown inside the signed documents.Refer to the list of available timestamp formats. By default, the timestamp format matches the timestamp format specified in the envelope.
The keys of the documents included in the deliverable. By default, all documents in the envelope are included.
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 includes only the signed documents without an audit log. If you need an audit log, use the Standard Deliverable instead.
A user-provided name for this deliverable. Must contain only lowercase letters, numbers, and underscores, and start with a letter. Helpful to identify its changes via events.
The type of the deliverable.Available options are
standard and simple. The default is standard.standard: Includes all documents and an audit logsimple: Includes only the documents without an audit log
simple.The keys of the documents included in the deliverable. By default, all documents in the envelope are included.
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_...
{
"type": "standard",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
}
Copy
Ask AI
// 201 Created
{
"id": "del_3gGNgIxxxxo8Xn7epZQ8F",
"name": null,
"envelope_id": "4ec99c57-4430-4d73-8afd-912dcf4b5880",
"type": "standard",
"language": "en",
"timezone": "UTC",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum", "exhibit_a"],
"password": null,
"status": "processing",
"url": null,
"created_at": "2025-12-31T23:59:59.999Z",
"generated_at": null
}
Was this page helpful?
⌘I
Assistant
Responses are generated using AI and may contain mistakes.