- Standard deliverable: A PDF file that includes both the signed documents and an audit log of the signing process (this is the default type)
- Simple deliverable: A PDF file that contains only the signed documents without the audit log
Attributes
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.
The unique identifier of the deliverable.
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 unique identifier of the envelope.
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.
The current status of the deliverable.Available options are
pending, processing, generated, and failed.pending: The deliverable is pending generation while the envelope is not yet completed.processing: The envelope is completed and the deliverable is being generated.generated: The deliverable has been generated. The object includes aurlfor download.failed: The deliverable failed to be generated.
The URL for downloading the deliverable. This link is intended for immediate use, as it expires after a short
period.
- By default, this is a short‑lived, pre‑signed URL that requires no additional authentication.
- The URL expires after 1 hour. If the link has expired, retrieve the deliverable again to get a new URL.
- If your account uses authenticated URLs (for example, for HIPAA compliance), you must access this URL with your API key like any other API request. Authenticated URLs do not expire.
null until the deliverable is generated.Time at which the deliverable was created, in ISO 8601 format.
Time at which the deliverable was generated, in ISO 8601 format. This value can be
null until the deliverable is generated.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.
The unique identifier of the deliverable.
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 unique identifier of the envelope.
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.
The current status of the deliverable.Available options are
pending, processing, generated, and failed.pending: The deliverable is pending generation while the envelope is not yet completed.processing: The envelope is completed and the deliverable is being generated.generated: The deliverable has been generated. The object includes aurlfor download.failed: The deliverable failed to be generated.
The URL for downloading the deliverable. This link is intended for immediate use, as it expires after a short
period.
- By default, this is a short‑lived, pre‑signed URL that requires no additional authentication.
- The URL expires after 1 hour. If the link has expired, retrieve the deliverable again to get a new URL.
- If your account uses authenticated URLs (for example, for HIPAA compliance), you must access this URL with your API key like any other API request. Authenticated URLs do not expire.
null until the deliverable is generated.Time at which the deliverable was created, in ISO 8601 format.
Time at which the deliverable was generated, in ISO 8601 format. This value can be
null until the deliverable is generated.Copy
Ask AI
{
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"name": null,
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "standard",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss",
"included_documents": ["contract", "addendum"],
"password": null,
"status": "generated",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault/envelopes/52872f0e...",
"created_at": "2025-12-31T12:00:00.000Z",
"generated_at": "2025-12-31T12:01:30.000Z"
}