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

#Signer

Signer information with current status (based on SignerGetDto which extends SignerBaseDto)

#Properties

NameTypeDescription
IdString

Unique signer identifier

ExpiresString

When the signer's access expires

EmailString

Signer's email address

AuthenticationsArray<SignerAuthentication>

Authentication methods for this signer

VerificationsArray<SignerVerification>

Verification methods for this signer

SendSignRequestBoolean

Whether to send sign request to this signer

SendSignConfirmationBoolean

Whether to send a confirmation email after signing

SignRequestSubjectString

Custom subject for sign request email

SignRequestMessageString

Custom message for sign request email

DaysToRemindInteger

Days between reminder emails (0 = no reminders)

Languageenum:
  • de-DE
  • en-US
  • es-ES
  • fr-FR
  • it-IT
  • pl-PL
  • nl-NL

Language for signer interface and emails

ReferenceString

Custom reference for this signer

IntroTextString

Custom introduction text shown to the signer

ReturnUrlString

URL to redirect signer after signing

AllowDelegationBoolean

Whether this signer can delegate signing to another person

ContextObject

Custom signer data (dynamic JSON object)

ActivitiesArray<Activity>

Activities/events for this signer

RejectReasonString

Reason provided if the signer rejected the transaction

DelegateReasonString

Reason provided for delegation

DelegateSignerEmailString

Email of the delegate signer

DelegateSignerNameString

Name of the delegate signer

DelegateSignUrlString

URL for delegate to sign

SignedDateTimeString

When the signer completed signing

RejectDateTimeString

When the signer rejected the transaction

CreatedDateTimeString

When the signer was added

SignerDelegationDateTimeString

When the signer delegated to another person

ModifiedDateTimeString

When the signer was last modified

ShowUrlString

A unique URL per signer that provides the secure download flow for the signer. Available if any of the authentications SecureDownload field is set to true.

ReceiptUrlString

A unique URL per signer that provides the receipt download flow for the signer. Available if any of the authentications SecureDownload field is set to true.