Umschlag erstellen

POST /esignglobal/v1/envelope/create

Schnittstellenbeschreibung

Erstellt einen Umschlag im Entwurfsstatus.

Anforderungsparameter

Parametername		Typ	Pflichtfeld	Beschreibung
subject		string	true	Betreff des Umschlags, Beispiel: „Offer Letter“
remark		string	false	Notiz zum Umschlag, maximale Länge 1000 Zeichen
signerSettings		object	false	Vom Unterzeichner zulässige Aktionen
	allowTransfer	boolean	false	Ob der Unterzeichner den Umschlag an eine andere Person zur Unterschrift weiterleiten darf, Standardwert false true- Der Unterzeichner im Umschlag hat die Befugnis, diesen an eine andere Person weiterzuleiten; false- Der Unterzeichner im Umschlag hat nicht die Befugnis, diesen an eine andere Person weiterzuleiten;
	allowModifyName	boolean	false	Ob der Unterzeichner seinen Namen ändern darf, gilt nur für Vorlagenunterschriften, Standardwert false true- Der Unterzeichner darf seinen Namen ändern false- Unterschriftsberechtigte dürfen den Namen nicht ändern
tspScope		array	false	Umfang der TSP auf Envelope-Ebene, standardmäßig false. Nach Angabe muss bei der Hinzufügung eines Unterschriftsberechtigten ein TSP aus dem angegebenen Bereich ausgewählt werden. Die Aufzählungswerte umfassen: vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni、belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia、estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom、harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId、mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign、smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe、certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha。
expireAfterSeconds		long	false	Envelope-Verfallszeit: Nach wie vielen Sekunden verfällt der Envelope Verfallsbereich: 86.400 Sekunden (1 Tag) bis 7.776.000 Sekunden (90 Tage).
redirectUrl		string	false	Umleitungsadresse nach Abschluss der Unterschrift (Länge 2048), muss eine gültige HTTP-Adresse sein
callBackUrl		string	false	Callback-Adresse (Länge 500), muss einer HTTPS-/HTTP-Protokolladresse entsprechen

Anfragebeispiel

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Antwortparameter

Parametername

Typ

Beschreibung

envelopeId

string

Envelope-ID

envelopeStatus

int

Envelope-Status

0 – Erstellt (Entwurf)

1-Unterzeichnung läuft

2-Abschließen

3-Ablaufdatum überschritten

5-Widerrufen

Antwortbeispiel

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}