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

#Receiver

Receiver information (based on ReceiverGetDto which extends ReceiverBaseDto)

#Properties

NameTypeDescription
NameString

Receiver's name

EmailString

Receiver's email address

LanguageString

Language for receiver communications

SubjectString

Custom subject for notification email

MessageString

Custom message for notification email

ReferenceString

Custom reference for this receiver

ContextObject

Custom receiver data (dynamic JSON object)

IdString

Unique receiver identifier

ActivitiesArray<Activity>

Activities/events for this receiver

CreatedDateTimeString

When the receiver was added

ModifiedDateTimeString

When the receiver was last modified