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

#CreateSignerRequest

Request object for creating a new signer in a transaction. Defines the signer's identity, authentication/verification requirements, notification preferences, and signing behavior.

Key Requirements:

  • Email address is mandatory
  • Either Authentications or Verifications must be provided (or both)
  • Signers with AllowDelegation enabled cannot have Authentications
  • SendSignRequest determines if sign request emails are sent automatically

#Properties

NameTypeDescription
IdString

Signer identifier (can be provided or generated)

ExpiresString

When the signer's access expires

EmailStringRequired.

Signer's email address

AuthenticationsArray<SignerAuthentication>

List of authentications that the signer has to authenticate with. The order in which the authentications are provided determine in which order the signer will have to perform the specified method.

Authentications must be performed before the document(s) can be viewed.

When the authentication SecureDownload is configured, the download url for a signer is authenticated with the same method as the signing url.

The download url is returned in the response, and (optionally) emailed to the signer.

You must explicitly specify the API-version when using this feature. This is done with the header: 'Accept: application/vnd.signhost.v1+json'.

VerificationsArray<SignerVerification>

List of verifications that the signer has to verify with.

The order in which the verifications are provided determine in which order the signer will have to perform the specified method.

Verifications must be performed before the document(s) can be signed.

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

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

Important Notes:

  • SigningCertificate and CSC Qualified must always be the final verification and cannot have any verifications after them (including each other)
  • SigningCertificate and CSC Qualified cannot be used together in the same signer
  • The other three methods (Consent, PhoneNumber, Scribble) can be preceded by other verification methods

Common mistake: Providing only authentication methods (e.g., iDIN) without including one of these required final verification methods.

SendSignRequestBoolean

Whether to send sign request to this signer's email address

SendSignConfirmationBoolean

Whether to send a confirmation email to the signer after signing. Default value is the value of SendSignRequest

SignRequestSubjectString

The subject of the sign request email in plain text. Maximum of 64 characters allowed.

If omitted, the default subject will be used.

SignRequestMessageString

The message of the sign request email in plain text. HTML is not allowed. Newlines can be created by including a \n. Required if SendSignRequest is true.

DaysToRemindInteger

Number of days between automatic reminder emails sent to this signer.

  • Set to -1 to disable reminders entirely for this signer
  • Set to 0 to use your organization's default reminder interval
  • Set to a positive number (e.g., 3, 7) to send reminders every N days

Note: Reminders are only sent if SendSignRequest is true and the signer hasn't completed signing yet.

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 during the signing proces. This will be shown on the first screen to the signer and supports limited markdown markup. The following markup is supported:

  • # Headings
  • *Emphasis* / _Emphasis_
  • **Strong** / __Strong__
  • 1. Ordered and - Unordered lists
ReturnUrlString

URL to redirect signer after signing

AllowDelegationBoolean

Whether this signer can delegate signing to another person. Cannot be used together with Authentications.

ContextObject

Custom signer data (dynamic JSON object)