Types
SignatureAPI offers two deliverable types:| Type | Description |
|---|---|
| Standard deliverable | Includes the signed documents and an audit log. This is the default. |
| Simple deliverable | Includes the signed documents only, without an audit log. |
Lifecycle
A deliverable’sstatus tracks its progress from creation to completion. See the deliverable lifecycle for details on each status.
Attributes
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.
The unique identifier for this deliverable.
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 unique identifier of the envelope, in UUID format.
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 current status of the deliverable.
pending: The envelope is not yet completed. The deliverable is waiting to be generated.processing: The envelope has completed and the deliverable is being generated. This usually takes a few seconds.generated: The deliverable is ready. Theurlproperty contains a download link.failed: The deliverable failed to generate. This is rare. SignatureAPI support is notified automatically.
The URL for downloading the deliverable.
null until the deliverable reaches generated status.By default, this is a pre-signed URL. It requires no additional authentication and expires after 1 hour. If the link has expired, retrieve the deliverable again to get a fresh URL.If your account uses authenticated URLs (for HIPAA compliance, for example), access this URL with your API key as you would any other API request. Authenticated URLs do not expire.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.
The time the deliverable was created, in ISO 8601 format. Set when the envelope is created, or when a deliverable is created via the API.
The time the deliverable was successfully generated, in ISO 8601 format.
null until the deliverable reaches generated status.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.
The unique identifier for this deliverable.
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 unique identifier of the envelope, in UUID format.
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 current status of the deliverable.
pending: The envelope is not yet completed. The deliverable is waiting to be generated.processing: The envelope has completed and the deliverable is being generated. This usually takes a few seconds.generated: The deliverable is ready. Theurlproperty contains a download link.failed: The deliverable failed to generate. This is rare. SignatureAPI support is notified automatically.
The URL for downloading the deliverable.
null until the deliverable reaches generated status.By default, this is a pre-signed URL. It requires no additional authentication and expires after 1 hour. If the link has expired, retrieve the deliverable again to get a fresh URL.If your account uses authenticated URLs (for HIPAA compliance, for example), access this URL with your API key as you would any other API request. Authenticated URLs do not expire.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.
The time the deliverable was created, in ISO 8601 format. Set when the envelope is created, or when a deliverable is created via the API.
The time the deliverable was successfully generated, in ISO 8601 format.
null until the deliverable reaches generated status.Copy
Ask AI
// HTTP Status Code 200
{
"id": "del_LXRDwyTeJDVrWXmjwxsAGPq",
"name": null,
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "standard",
"status": "generated",
"url": "https://vault.signatureapi.com/envelopes/52872f0e-b919-4d69-89cd-e7e56af00548/deliverables/del_LXRDwyTeJDVrWXmjwxsAGPq...",
"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": "2024-01-01T00:01:00Z"
}