Signaturvorgang mit der Umschlagvorlage starten

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

Schnittstellenbeschreibung

Initiieren Sie die Unterschrift unter Verwendung der auf der Clientseite vorkonfigurierten „Umschlagvorlage“.

Anforderungsparameter

Parametername				Typ	Erforderlich	Beschreibung
envelopeTemplateId				string	true	Umschlagvorlagen-ID
envelopeConfig				object	true	Konfiguration des Signaturprozesses
	contractConfig			boolean	false	Konfiguration der Vertragsunterschrift
		envelopeRemark		array	false	Vertragsnotizen
	envelopeSubject			string	true	Betreff dieses Signaturvorgangs
	expireAfterSeconds			int	false	Unterschriftsfrist für diesen Vorgang. Nach Ablauf dieser Zeit ist keine Unterschrift mehr möglich. Unix-Zeitstempel in Millisekunden, Standard- und maximale Gültigkeitsdauer 90 Tage.
	callbackUrl			string	false	Web-Adresse zum Empfang von Callback-Benachrichtigungen
	redirectUrl			string	false	Muss eine gültige HTTPS-Adresse sein
	signConfig			object	false	Signaturkonfiguration
		allowTransfer		boolean	false	Ob der Unterzeichner diesen Envelope an andere Personen zur Unterschrift weiterleiten darf, Standardwert false true- Erlaubt den Unterzeichnern im Envelope, diesen an Dritte weiterzuleiten; false- Erlaubt den Unterzeichnern im Envelope nicht, diesen an Dritte weiterzuleiten;
participants				array	false	Teilnehmerkonfiguration
	participantId			string	true	Teilnehmer-ID
	authConfig			object	false	Authentifizierungskonfiguration
		willingnessAuthModes		array	false	Optionale Verifikationsmethode für den Unterzeichner, Standardwert noAuth noAuth- Keine Verifikation accessCode- Verifizierung mittels Zugangscode sms- SMS-OTP-Verifizierung idVerification- Verifizierung eines Identitätsdokuments emailAuth- E-Mail-OTP-Verifizierung digitalId- Digitale Identitätsverifizierung whatsappAuth- WhatsApp-OTP-Verifizierung
		accessCode		object	false	Signierpasswort-Einstellungen, erforderlich wenn authModes=accessCode
			accessCode	string	false	Passwortinhalt, nicht case-sensitiv, kann alphanumerische Zeichen enthalten, maximale Länge 45
			promptInfo	string	false	Hinweistext für das Zugriffspasswort, darf das Passwort nicht enthalten, maximale Länge 30, erforderlich wenn authModes=1.
		sms		object	false	SMS-OTP-Validierung, erforderlich wenn authModes=sms
			countryCode	string	false	Länder-/Regions-Kennung, "+" muss nicht übergeben werden
			number	string	false	Keine Formatprüfung, lediglich maximale Länge von 13 Zeichen
		idVerification		object	false	Einstellungen zur Ausweisverifizierung, erforderlich wenn authModes=idVerification
			name	string	false	Vollständiger Name auf dem Ausweisdokument des Unterzeichners, maximale Länge 100 Zeichen
		emailAuth		object	false	E-Mail-OTP-Validierung, erforderlich wenn authModes=emailAuth
			authEmail	string	false	E-Mail-Adresse des Unterzeichners zur Identitätsprüfung
		digitalId		array	false	Elektronische Identitätsverifizierung, erforderlich wenn authModes=digitalId
			authApp	string	false	App zur elektronischen Identitätsverifizierung singpass-Identitätsauthentifizierung mit Singpass iamsmart-Identitätsauthentifizierung mit iAM Smart
			idNumber	string	false	Ausweisnummer des Unterzeichners zur Verifizierung
		whatsappAuth		object	false	WhatsApp-OTP-Validierung, erforderlich, wenn authModes=whatsappAuth
			countryCode	string	false	Ländervorwahl, '+' muss nicht angegeben werden
			number	string	false	Keine Formatvalidierung, lediglich auf eine maximale Länge von 13 Zeichen beschränkt
	participantInfos			object	false	Natürliche Person als Teilnehmer
		userEmail		string	false	E-Mail-Adresse des Unterzeichners
		phoneNumber		object	false	Telefonnummer, standardmäßig leer Bei SMS-Benachrichtigung erforderlich; countryCode und number müssen beide übergeben werden
			countryCode	string	false	Ländervorwahl, '+' muss nicht angegeben werden
			number	string	false	Keine Formatvalidierung, lediglich auf eine maximale Länge von 13 Zeichen beschränkt
		userName		string	false	Name der natürlichen Person
		deliveryMethod		string	false	Benachrichtigungskanal none - Keine Nachrichtbenachrichtigung senden email - E-Mail-Benachrichtigung senden sms - SMS-Benachrichtigung senden WhatsApp - WhatsApp-Benachrichtigung senden
		customizeSettings		object	false	Benutzerdefinierte Konfiguration
			customizeMessage	object	false	Benutzerdefinierte Konfiguration für Benachrichtigungen
			notificationLanguage	string	false	Benachrichtigungssprache, standardmäßig Englisch en-US Englisch zh-CN Chinesisch (vereinfacht) zh-Hant Chinesisch (traditionell) ja Japanisch ES-MX Spanisch
copiers				array	false	CC-Empfänger hinzufügen
	copierId			string	true	Teilnehmer-ID
	CCInfos			object	false	Informationen zum CC-Empfänger
		userEmail		string	false	E-Mail
		userName		string	false	Persönlicher Name
		customizeSettings		object	false	Benutzerdefinierte Konfiguration
			customizeMessage	object	false	Benutzerdefinierte Konfiguration für Benachrichtigungen
			notificationLanguage	string	false	Benachrichtigungssprache, standardmäßig Englisch en-US Englisch zh-CN Vereinfachtes Chinesisch zh-Hant Traditionelles Chinesisch ja Japanisch ES-MX Spanisch
attchments				array	false	Informationen zum Anhang (nicht signierte Datei)
	documentId			string	false	Anhangsdatei-ID
	fileName			string	false	Anhangsdateiname
components				array	false	Liste der Steuerelemente
	documentId			string	false	Datei-ID des Steuerelements
	componentId			string	false	Steuerelement-ID
	componentKey			string	false	Steuerelement-key (entweder Steuerelement-id oder Steuerelement-key auswählen)
	componentValue			string	false	Vorbelegter Wert des Steuerelements
	editComponentValue			boolean	false	Legt fest, ob der Unterzeichner den Vorbelegungsinhalt dieses Steuerelements ändern kann, Standardwert: true true - Der Unterzeichner kann die vorausgefüllten Werte ändern false - Bei Vorausfüllwerten wird der Modus auf schreibgeschützt festgelegt, der Unterzeichner kann sie nicht ändern

Anfragebeispiel

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

Antwortparameter

Parametername	Typ	Beschreibung
envelopeId	string	Envelope-ID

Antwortbeispiel

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}