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

#CreateReceiverRequest

Receiver configuration for getting copies of signed documents

#Properties

NameTypeDescription
NameString

Receiver's name

EmailStringRequired.

Receiver's email address

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

Language for receiver communications

SubjectString

Custom subject for notification email. Maximum of 64 characters allowed. Omitting this parameter will enable the default subject.

MessageStringRequired.

Custom message for notification email. Newlines can be created by including a \n in the message. HTML is not allowed.

ReferenceString

Custom reference for this receiver

ContextObject

Custom receiver data (JSON object only)