CreateTransactionRequest

    Transaction creation data including signers, receivers, files, and configuration. This is the request body for creating a new transaction.

    Properties

    NameTypeDescription
    SealBooleanRequired.

    Whether to seal the transaction (no signers required). When true, the transaction is automatically completed without requiring signatures.

    ReferenceString

    Custom reference identifier for the transaction

    PostbackUrlString

    URL to receive status notifications about the transaction

    DaysToExpireInteger

    Number of days until the transaction expires. If 0, uses organization default. Maximum value depends on organization settings.

    SendEmailNotificationsBoolean

    Whether to send email notifications to signers and receivers

    SignRequestModeenum:
    • 0
    • 1
    • 2

    Mode for sign request delivery:

    • 0: No sign requests
    • 1: Send immediately
    • 2: Send when ready (default when signers have SendSignRequest enabled)
    Languageenum:
    • de-DE
    • en-US
    • es-ES
    • fr-FR
    • it-IT
    • pl-PL
    • nl-NL

    Language code for transaction interface and emails

    ContextObject

    Custom JSON object for additional transaction data. Only JSON objects are allowed (no arrays or primitives).

    SignersArray<CreateSignerRequest>

    List of signers for the transaction

    ReceiversArray<CreateReceiverRequest>

    List of receivers who get copies of completed documents

    Example:

    {
  "Seal": false,
  "Reference": "CONTRACT-2024-001",
  "PostbackUrl": "https://example.com/webhook/signhost",
  "DaysToExpire": 30,
  "SendEmailNotifications": true,
  "SignRequestMode": 2,
  "Language": "en-US",
  "Context": {
    "department": "HR",
    "contract_type": "employment"
  },
  "Signers": [
    {
      "Email": "john.doe@example.com",
      "SendSignRequest": true,
      "SignRequestMessage": "Please review and sign the attached employment contract.",
      "Language": "en-US"
    }
  ],
  "Receivers": [
    {
      "Email": "hr@example.com",
      "Message": "The employment contract has been signed and is attached.",
      "Language": "en-US"
    }
  ]
}