Standard Deliverable

The standard deliverable is a PDF that contains both the signed documents and an audit log. The audit log records every action taken during the signing process and includes a certificate of completion. This is the default deliverable type.

Example

Generating a Standard Deliverable

You can generate a standard deliverable in two ways: automatically when the envelope completes, or manually using the Create Deliverable endpoint.

Automatic (On Envelope Completion)

By default, SignatureAPI automatically generates a standard deliverable when an envelope completes. The deliverable is sent to recipients when it is ready.

The deliverable inherits the envelope’s language, timezone, and timestamp_format settings. You can override these by including a deliverable object when creating the envelope.

For example, to set the deliverable’s audit log language to English while the envelope uses French:

// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "title": "Service Agreement",
    "language": "fr",
    "documents": [ //... ],
    "recipients": [ //... ],
    "deliverable": {
        "type": "standard",
        "language": "en"
    }
}

Manual (Create Deliverable Endpoint)

You can also create a standard deliverable manually at any time after the envelope completes, using the Create Deliverable endpoint.

// POST https://api.signatureapi.com/v1/envelopes/{envelope_id}/deliverables
// X-API-Key: key_test_...
// Content-Type: application/json

{
    "type": "standard"
}

Customization

Language

The language property sets the language for system-generated text in the audit log, such as labels and the certificate of completion. It does not affect the content of the signed documents.

See available languages. Defaults to the envelope language.

Timezone

The timezone property sets the timezone for timestamps in the audit log. It does not affect timestamps inside the signed documents.

See available timezones. Defaults to the envelope timezone.

Timestamp Format

The timestamp_format property sets the format for timestamps in the audit log. It does not affect timestamps inside the signed documents.

See available timestamp formats. Defaults to the envelope timestamp format.

Included Documents

The included_documents property specifies which documents from the envelope to include in the deliverable. By default, all documents are included. Accepts between 1 and 10 document keys.

Use this to generate separate deliverables for different documents, or to exclude certain documents from the final PDF.

{
    "type": "standard",
    "included_documents": ["contract", "addendum"]
}

Password Protection

To protect your deliverable with password encryption, see Password Protection.