logologo
Docs
API
Reference
Live API
About
Blog
Docs
Reference
Live API
About
Blog
logologo
Introduction

Transactions

Create Transaction
Start a transaction
Get a transaction by ID
Delete / Cancel a Transaction

Files

Download receipt for a transaction
Download a file from a transaction
Upload PDF file or file metadata

Models

CreateTransactionRequest
Transaction
CreateSignerRequest
Signer
CreateReceiverRequest
Receiver
SignerAuthentication
SignerVerification
SignerScribbleVerification
SignerEmailVerification
SignerPhoneNumberIdentification
SignerDigidIdentification
SignerIDealVerification
SignerSurfnetVerification
SignerIDINVerification
SignerIPAddressVerification
SignerEHerkenningVerification
SignerEidasLoginVerification
SignerItsmeIdentificationVerification
SignerConsentVerification
SignerCscVerification
SignerOidcIdentification
SignerOnfidoIdentification
FileEntry
Link
Activity
FileMetadata
FileSignerData
FileField
FileFieldType
FileFieldLocation
TransactionDeleteOptions
ErrorResponse

#Transaction

Complete transaction data returned when retrieving or creating a transaction. Includes all configuration, current status, and file information.

#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.