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
SignerSigningCertificateVerification
SignerCscVerification
SignerOidcIdentification
SignerOnfidoIdentification
FileEntry
Link
Activity
FileMetadata
FileSignerData
FileField
FileFieldType
FileFieldLocation
TransactionDeleteOptions
ErrorResponse

#Start a transaction

Method: PUT

Path: /api/transaction/{transactionId}/start

Start the signing process for a transaction. All required files and signers must be configured before starting. Once started, the transaction cannot be modified and signers will be notified to begin signing.

#Parameters

NameInTypeRequiredDescription
transactionIdpathstringYes

The transaction ID to start

#Responses

#204

Transaction started successfully

#400

The transaction could not be started. This typically occurs if the transaction contains errors or is in a Failed status.

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

#401

Unauthorized - user not creator of transaction

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

#403

Forbidden - authorization policy violation

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message

#500

Internal server error

Content-Type: application/json

Schema: ErrorResponse

#Properties

NameTypeDescription
MessageStringRequired.

Human-readable error message