Get a transaction by ID

    Method: GET

    Path: /api/transaction/{transactionId}

    Retrieve transaction details including signers, receivers, files, and current status.

    Do not use this method for active polling. Use the postback service instead.

    Parameters

    NameInTypeRequiredDescription
    transactionIdpathstringYes

    The transaction ID to retrieve

    Responses

    200

    Transaction retrieved successfully

    Content-Type: application/json

    Schema: Transaction

    Properties

    NameTypeDescription
    IdString

    Unique transaction identifier

    SealBoolean

    Whether the transaction is sealed (no signers required)

    ReferenceString

    Custom reference identifier

    PostbackUrlString

    Webhook URL for status notifications

    DaysToExpireInteger

    Days until the transaction expires.

    SendEmailNotificationsBoolean

    Send e-mail notifications to the sender.

    SignRequestModeenum:
    • 1
    • 2

    Sign request delivery mode

    • 1: Send immediately
    • 2: Send sequentially when ready (default when signers have SendSignRequest enabled) Note: Ignored if SendSignRequest is set to false.
    Languageenum:
    • de-DE
    • en-US
    • es-ES
    • fr-FR
    • it-IT
    • pl-PL
    • nl-NL

    Language code for the Sender email notifications, and transaction receipt.

    Statusenum:
    • 5
    • 10
    • 20
    • 30
    • 40
    • 50
    • 60
    • 70

    Current transaction status:

    • 5: Waiting For Document - Transaction created, documents being processed/prepared
    • 10: Waiting For Signer - Documents ready, waiting for signers to sign
    • 20: In Progress - A signer is currently in the process of signing
    • 30: Signed - All signers have successfully signed the transaction
    • 40: Rejected - One or more signers rejected the transaction
    • 50: Expired - Transaction expired before all signers could complete
    • 60: Cancelled - Transaction was cancelled by the creator
    • 70: Failed - Transaction failed due to system errors or validation issues
    ContextObject

    Custom JSON object for additional transaction metadata that was provided during creation.

    CreatedDateTimeString

    When the transaction was created

    ModifiedDateTimeString

    When the transaction was last modified

    CanceledDateTimeString

    When the transaction was cancelled, if applicable

    FilesObject

    Files attached to the transaction as a key-value mapping. Key is the file ID, value is the file information.

    SignersArray<Signer>

    List of signers attached to this transaction, including their configuration, current status, verification methods, and signing progress. Each signer represents an individual who needs to sign the document or has already completed the signing process.

    ReceiversArray<Receiver>

    List of receivers who will receive copies of the completed signed documents. Receivers are notified via email once the transaction is successfully completed and all required signatures have been obtained.

    CancelationReasonString

    The reason for the cancellation of the transaction, if applicable. This is provided when the transaction is cancelled via the DELETE endpoint.

    401

    Unauthorized - user not owner of transaction

    Content-Type: application/json

    Schema: ErrorResponse

    Properties

    NameTypeDescription
    typeString

    A URI reference identifying the problem type. This property is always present in RFC 7807 responses.

    titleString

    A short, human-readable summary of the problem

    detailString

    A human-readable explanation specific to this occurrence of the problem

    statusInteger

    The HTTP status code

    instanceString

    A URI reference that identifies the specific occurrence of the problem

    MessageString

    Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.

    Example:

    {
  "Message": "Authorization has been denied for this request."
}

    410

    The transaction details are no longer available and as a result the returned JSON only contains partial historical data. This happens when the system cleaned the transaction for example due to reaching an end status (any status above 30) or the transaction has expired.

    Content-Type: application/json

    Schema: Transaction

    Properties

    NameTypeDescription
    IdString

    Unique transaction identifier

    SealBoolean

    Whether the transaction is sealed (no signers required)

    ReferenceString

    Custom reference identifier

    PostbackUrlString

    Webhook URL for status notifications

    DaysToExpireInteger

    Days until the transaction expires.

    SendEmailNotificationsBoolean

    Send e-mail notifications to the sender.

    SignRequestModeenum:
    • 1
    • 2

    Sign request delivery mode

    • 1: Send immediately
    • 2: Send sequentially when ready (default when signers have SendSignRequest enabled) Note: Ignored if SendSignRequest is set to false.
    Languageenum:
    • de-DE
    • en-US
    • es-ES
    • fr-FR
    • it-IT
    • pl-PL
    • nl-NL

    Language code for the Sender email notifications, and transaction receipt.

    Statusenum:
    • 5
    • 10
    • 20
    • 30
    • 40
    • 50
    • 60
    • 70

    Current transaction status:

    • 5: Waiting For Document - Transaction created, documents being processed/prepared
    • 10: Waiting For Signer - Documents ready, waiting for signers to sign
    • 20: In Progress - A signer is currently in the process of signing
    • 30: Signed - All signers have successfully signed the transaction
    • 40: Rejected - One or more signers rejected the transaction
    • 50: Expired - Transaction expired before all signers could complete
    • 60: Cancelled - Transaction was cancelled by the creator
    • 70: Failed - Transaction failed due to system errors or validation issues
    ContextObject

    Custom JSON object for additional transaction metadata that was provided during creation.

    CreatedDateTimeString

    When the transaction was created

    ModifiedDateTimeString

    When the transaction was last modified

    CanceledDateTimeString

    When the transaction was cancelled, if applicable

    FilesObject

    Files attached to the transaction as a key-value mapping. Key is the file ID, value is the file information.

    SignersArray<Signer>

    List of signers attached to this transaction, including their configuration, current status, verification methods, and signing progress. Each signer represents an individual who needs to sign the document or has already completed the signing process.

    ReceiversArray<Receiver>

    List of receivers who will receive copies of the completed signed documents. Receivers are notified via email once the transaction is successfully completed and all required signatures have been obtained.

    CancelationReasonString

    The reason for the cancellation of the transaction, if applicable. This is provided when the transaction is cancelled via the DELETE endpoint.

    500

    Internal server error

    Content-Type: application/json

    Schema: ErrorResponse

    Properties

    NameTypeDescription
    typeString

    A URI reference identifying the problem type. This property is always present in RFC 7807 responses.

    titleString

    A short, human-readable summary of the problem

    detailString

    A human-readable explanation specific to this occurrence of the problem

    statusInteger

    The HTTP status code

    instanceString

    A URI reference that identifies the specific occurrence of the problem

    MessageString

    Deprecated (Legacy Format Only): Contains the error message in the old response format. This property appears alone in legacy error responses and is mutually exclusive with the RFC 7807 properties above. Will be phased out as we complete our transition to RFC 7807.