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

#SignerVerification

Verification methods used to confirm signer identity before document signing. These methods must be completed before the signer can sign documents.

Important: The "Type" property is case-sensitive and must be capitalized.

Critical Requirement: You must use one of the following verification methods as the last verification in your verifications list:

  • Consent
  • PhoneNumber
  • Scribble
  • SigningCertificate*
  • CSC Qualified*

Special Rules for SigningCertificate and CSC Qualified:

  • These two methods must always be the absolute final verification - nothing can come after them
  • SigningCertificate and CSC Qualified cannot be used together in the same signer's verification list
  • If you use SigningCertificate or CSC Qualified, it must be the only item in the verifications array OR the last item after other verifications

Rules for Consent, PhoneNumber, and Scribble:

  • These three can be used as the final verification method
  • They can be preceded by other verification methods (e.g., iDIN, Digid, etc.)
  • They are commonly used when you want additional verification steps before the final consent/signature

Common Mistakes:

  • Using only authentication methods (e.g., iDIN) without a final verification method
  • Placing verifications after SigningCertificate or CSC Qualified
  • Using both SigningCertificate and CSC Qualified together

Valid Examples:

  • [Consent] ✓
  • [iDIN, Consent] ✓
  • [iDIN, PhoneNumber] ✓
  • [SigningCertificate] ✓
  • [iDIN, SigningCertificate] ✓
  • [SigningCertificate, Consent] ✗ (Nothing can come after SigningCertificate)
  • [SigningCertificate, CSC Qualified] ✗ (Cannot use both together)
  • [iDIN] ✗ (Missing required final verification)

#Discriminator

This is a polymorphic schema that uses the Type property to determine the specific type.

#One Of Schemas

The following schemas can be used:

  • SignerScribbleVerification
  • SignerEmailVerification
  • SignerPhoneNumberIdentification
  • SignerDigidIdentification
  • SignerIDealVerification
  • SignerSurfnetVerification
  • SignerIDINVerification
  • SignerIPAddressVerification
  • SignerEHerkenningVerification
  • SignerEidasLoginVerification
  • SignerItsmeIdentificationVerification
  • SignerConsentVerification
  • SignerSigningCertificateVerification
  • SignerCscVerification
  • SignerOidcIdentification
  • SignerOnfidoIdentification