eSignature

  1. Home
  2. API Library
  3. eSignature
eSignature-Lösungen mit europäischer Gültigkeit – alles in einer API

eSignature ist die API zur Automatisierung digitaler Dokumentensignaturen – konform mit der eIDAS-Verordnung und ohne feste Kosten: Sie zahlen nur für die tatsächliche Nutzung.

All das Wissen, das Sie benötigen

Hier finden Sie einige Ratschläge, die Sie berücksichtigen sollten, um sich dieser API zu nähern. Wenn Sie möchten, bieten wir Code-Beispiele, OAS3-Dokumentation, die Möglichkeit, die API live über Swagger UI auszuprobieren oder die gesamte Sammlung in Postman zu importieren. Wir bieten auch eine Sandbox-Umgebung an, in der Sie kostenlos mit allen Arten von Anfragen experimentieren können.

Nützliche Tipps für den Einstieg eSignature

Holen Sie sich das Token im entsprechenden Abschnitt, bevor Sie beginnen.

Verwenden Sie das Online-Tool oder generieren Sie es über die API. Legen Sie das Ablaufdatum, einen nützlichen Namen fest und fügen Sie jetzt eine Vielzahl von Scopes hinzu, um die möglichen Aktionen Ihres Tokens zu begrenzen.
Lesen Sie mehr über die OAuth-API Meine Tokens verwalten

Erhalten Sie Ihr Zertifikat

Verwenden Sie die folgenden Endpunkte, um ein Signaturzertifikat zu erhalten, mit dem Sie Ihre Dateien digital signieren können:

Erhalten Sie Ihr erstes Zertifikat

POST /certificates/namirial-automatic
Dieser Endpunkt ermöglicht es Ihnen, ein neues Zertifikat zu erhalten.
Die Antwort enthält einen Link der Registrierungsstelle, um die Identität zu überprüfen und das Zertifikat zu generieren.
Sobald der Vorgang abgeschlossen ist, erhält der Benutzer die Anmeldeinformationen, um mit dem Zertifikat zu signieren.
Da dies eine einmalige Operation sein kann, ziehen Sie es möglicherweise vor, unser Team zu kontaktieren, um weitere Informationen zu erhalten oder das Zertifikat manuell zu erhalten.

Erhalten Sie eine Liste der eigenen Zertifikate
GET /certificates
Dieser Endpunkt gibt eine Liste von Zertifikaten zurück. Die Liste kann nach Status und Zertifikatstyp gefiltert werden.

Zertifikatsdetails abrufen
GET /certificates/{id}
Dieser Endpunkt gibt die Details zu einem Zertifikat zurück.

Erstellen Sie Ihre erste E-Signatur

Verwenden Sie die folgenden Endpunkte, um elektronische Signaturen zu verwalten:

Erstellen Sie Ihre erste QES-Signatur

POST /EU-QES_automatic
Dieser Endpunkt ermöglicht es Ihnen, eine QES-Signatur mit einem massiven automatischen Zertifikat zu erstellen.
Geben Sie Ihr Dokument und die Zertifikatsanmeldeinformationen ein, um das Dokument zu signieren.
Die Antwort enthält die Signaturdetails. Nehmen Sie die {id} und...

Laden Sie das signierte Dokument herunter
GET /signatures/{id}/signedDocument
Die Ausgabe ist das signierte Dokument.

Erhalten Sie eine Liste der Signaturen
GET /signatures
Dieser Endpunkt gibt eine Liste von Signaturen zurück. Die Liste kann nach Status, Zertifikatstyp und Signaturtyp gefiltert werden.

Signaturdetails abrufen
GET /signatures/{id}/{actionType}
Dieser Endpunkt gibt die Details, das Audit, das signierte Dokument (signedDocument) oder das validierte Dokument (validatedDocument) einer Signatur zurück.

API docs by Redocly

E-Signature API (1.0.16)

URL: https://openapi.it/en/support Terms of Service

Diese API wurde entwickelt, um ein komplettes Set von Werkzeugen zur Integration elektronischer Signaturprozesse in jede Anwendung bereitzustellen.

Was Sie mit dieser API tun können:

  • erwerb und Erneuerung von physischen, Fern-, otp- oder automatischen Signaturzertifikaten
  • dokumente nach den wichtigsten eIDAS-Standards elektronisch signieren
    • QES (CAdES, PAdES, XAdES, PKCS#1, QTimestamp)
      • Fern-OTP
      • Massiv Automatisch
      • Massiv Automatisch E-Siegel
  • überprüfung der Gültigkeit eines signierten Dokuments
Zum ersten Mal hier? Generieren Sie ein neues Zugangstoken

Certificates

Signaturzertifikate erwerben oder erneuern

Mehr erfahren

Eine Liste der Zertifikate abrufen

Liefert eine Liste von Zertifikaten. Die Liste kann nach certificateType und Status gefiltert werden. Die verfügbaren Typen sind: EU-QES_automaticm EU-QES_otp. Die verfügbaren Zustände sind: NEW, EXPIRED und SUSPENDED.

Authorizations:
bearerAuth
query Parameters
certificateType
string
Enum: "EU-QES_automatic" "EU-QES_otp" "EU-QES_eseal"
Example: certificateType=EU-QES_automatic

Art der Bescheinigung

state
string
Enum: "NEW" "EXPIRED" "SUSPENDED"
Example: state=NEW

Zustand des Zertifikats

skip
integer >= 0
Default: 0

Anzahl der zu überspringenden Elemente

limit
integer [ 1 .. 100 ]
Default: 100
Example: limit=100

Maximale Anzahl der zurückzugebenden Artikel (min 1 max 100)

Responses

Response Schema: application/json
Array
id
string

ID des Zertifikats

certificateOwner
string

Name des Zertifikatsinhabers

customReference
string

Benutzerdefinierte Referenz für das Zertifikat

certificateType
string
Enum: "EU-QES_automatic" "EU-QES_otp"

Art der Bescheinigung

createdAt
string

Datum und Uhrzeit der Erstellung

expireAt
string

Datum und Uhrzeit des Ablaufs des Zertifikats

state
string
Enum: "NEW" "EXPIRED" "SUSPENDED"

Zustand des Zertifikats

certificateLink
string <uri>

URL zum Starten des Zertifikatsvergabeverfahrens

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://esignature.openapi.com/certificates?certificateType=SOME_STRING_VALUE&state=SOME_STRING_VALUE&skip=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
[
  • {
    }
]

Ein Zertifikat erhalten

Abrufen eines Zertifikats nach ID. Die Zertifikats-ID ist für den Zugriff auf den Dienst erforderlich.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 67af24c5af9b55291406e946

ID des Zertifikats

Responses

Response Schema: application/json
id
string

ID des Zertifikats

certificateOwner
string

Name des Zertifikatsinhabers

customReference
string

Benutzerdefinierte Referenz für das Zertifikat

certificateType
string
Enum: "EU-QES_automatic" "EU-QES_otp"

Art der Bescheinigung

createdAt
string

Datum und Uhrzeit der Erstellung

expireAt
string

Datum und Uhrzeit des Ablaufs des Zertifikats

state
string
Enum: "NEW" "EXPIRED" "SUSPENDED"

Zustand des Zertifikats

certificateLink
string <uri>

URL zum Starten des Zertifikatsvergabeverfahrens

object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://esignature.openapi.com/certificates/67af24c5af9b55291406e946");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "id": "67af24c5af9b55291406e946",
  • "certificateOwner": "John Doe",
  • "customReference": "MyCustomReference#123",
  • "certificateType": "EU-QES_automatic",
  • "createdAt": "2025-02-14 11:11:01.892+00:00",
  • "expireAt": "2025-02-14 11:11:01.892+00:00",
  • "state": "NEW",
  • "certificateLink": "https://my-domain.com/certificate.html",
  • "callback": {
    }
}

Kaufen Sie ein automatisches Namirial-Zertifikat

Erwerben Sie ein automatisches Namirial-Zertifikat. Das Zertifikat ist ein Jahr lang gültig und kann zum Signieren von Dokumenten im CAdES-, PAdES-, XAdES- und PKCS#1-Format verwendet werden. Die Prozedur gibt einen certificateLink zurück. Es handelt sich um einen einmaligen Vorgang der Zertifizierungsstelle, um den Inhaber des Zertifikats zu qualifizieren. Sobald der Vorgang abgeschlossen ist, erhält der Unterzeichner

Authorizations:
bearerAuth
Request Body schema: application/json

Erstellen Sie eine neue Anforderung für ein automatisches Namirial-Zertifikat, indem Sie die Zertifikatsdetails angeben.

certificateOwner
string

Name des Zertifikatsinhabers

customReference
string

Benutzerdefinierte Referenz für das Zertifikat, nützlich für die interne Verfolgung

object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
object
success
boolean

Erfolgreiche Operation

message
string

Nachricht

error
string or null

Fehlercode

Request samples

Content type
application/json
{
  • "certificateOwner": "John Doe",
  • "customReference": "MyCustomReference#123",
  • "callback": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "Certificate purchased successfully",
  • "error": ""
}

Kaufen Sie ein Namirial OTP-Zertifikat

Erwerben Sie ein Namirial OTP-Zertifikat. Das Zertifikat ist ein Jahr lang gültig und kann zum Signieren von Dokumenten im CAdES-, PAdES-, XAdES- und PKCS#1-Format verwendet werden.

Authorizations:
bearerAuth
Request Body schema: application/json

Erstellen Sie eine neue Anforderung für ein automatisches Namirial-Zertifikat, indem Sie die Zertifikatsdetails angeben.

certificateOwner
string

Name des Zertifikatsinhabers

customReference
string

Benutzerdefinierte Referenz für das Zertifikat, nützlich für die interne Verfolgung

object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
object
success
boolean

Erfolgreiche Operation

message
string

Nachricht

error
string or null

Fehlercode

Request samples

Content type
application/json
{
  • "certificateOwner": "John Doe",
  • "customReference": "MyCustomReference#123",
  • "callback": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "success": true,
  • "message": "Certificate purchased successfully",
  • "error": ""
}

Signatures

Anbringen einer elektronischen Signatur in einer Datei

Eine Liste der Unterschriften erhalten

Abrufen einer Liste von Signaturen. Die Liste kann nach Status, Zertifikatstyp und Signaturtyp gefiltert werden. Die verfügbaren Zustände sind: WAIT_VALIDATION, WAIT_SIGN, DONE, und ERROR. Die verfügbaren Zertifikatstypen sind: EU-QES_automatic, EU-QES_remote_otp, EU-QES_remote_eseal, EU-QES_disposable_recognition, EU-QES_disposable_spid, EU-QES_mail_otp, und EU-QES_sms_otp. Die verfügbaren Signaturtypen sind: cades, pades, xades und pkcs1.

Authorizations:
bearerAuth
query Parameters
state
string
Enum: "WAIT_VALIDATION" "WAIT_SIGN" "DONE" "ERROR"
Example: state=DONE

Stand der Unterschrift

certificateType
string
Enum: "EU-QES_automatic" "EU-QES_otp"
Example: certificateType=EU-QES_automatic

Art der Bescheinigung

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"
Example: signatureType=pades

Art der Unterschrift

skip
integer >= 0
Default: 0

Anzahl der zu überspringenden Elemente

limit
integer [ 1 .. 100 ]
Default: 100
Example: limit=100

Maximale Anzahl der zurückzugebenden Artikel (min 1 max 100)

Responses

Response Schema: application/json
Array
id
string

ID der Unterschrift

updatedAt
string

Datum und Uhrzeit der letzten Aktualisierung

createdAt
string

Datum und Uhrzeit der Erstellung

documentTitle
string

Titel des Dokuments

certificateType
string
Enum: "EU-QES_automatic" "EU-QES_remote_otp"

Art der Bescheinigung

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Art der Unterschrift

state
string
Enum: "WAIT_VALIDATION" "WAIT_SIGN" "DONE" "ERROR"

Stand der Unterschrift

errorNumber
integer or null

Fehlernummer

errorMessage
string or null

Fehlermeldung

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://esignature.openapi.com/signatures?state=SOME_STRING_VALUE&certificateType=SOME_STRING_VALUE&signatureType=SOME_STRING_VALUE&skip=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "success": true,
  • "message": "",
  • "error": null
}

Herunterladen des signierten Dokuments, Abrufen der Details, des Audit Trail oder des validierten Dokuments einer Signatur

Rufen Sie die Details, die Prüfung, das signierte Dokument oder das validierte Dokument einer Signatur ab.
Die Signatur-ID ist für den Zugriff auf den Dienst erforderlich.
Mit dem Parameter actionType kann die Art der abzurufenden Informationen angegeben werden.
Die verfügbaren Optionen sind: signedDocument, validatedDocument, audit und detail.
Das signedDocument und das validatedDocument geben den binären Inhalt der Datei zurück, die zum Herunterladen bereit ist.
Der Audit-Trail ist in mehreren Formaten verfügbar, die auf dem Accept-Wert des Request-Headers basieren.
Die verfügbaren Formate sind: application/json, text/plain, text/html, application/pdf.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 67af24c5af9b55291406e946

ID der Unterschrift

actionType
required
string
Default: ""
Enum: "detail" "audit" "signedDocument" "validatedDocument" ""
Example: detail

Art der auszuführenden Aktion, "detail" oder leer lassen für die Information über das signierte Dokument, "signedDocument", "audit" für den Audit Trail oder "validatedDocument"

Responses

Response Schema:
string <binary>

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://esignature.openapi.com/signatures/67af24c5af9b55291406e946/detail");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
Example
Loading...

QES-Signatur mit Massive Automatic Certificate erstellen

Erstellen Sie ein Signaturverfahren aus einer oder mehreren Dateien.

Beschaffung des Zertifikats:

Um auf den Dienst zugreifen zu können, benötigen Sie ein automatisches Zertifikat, das Sie über den entsprechenden Endpunkt "/certificates/namirial-automatic" erworben werden kann.

Verfügbare Formate:

Das System kann in den Formaten CAdES, PAdES, XAdES und PKCS#1 signieren.

Wenn nicht angegeben, sucht das System nach dem am besten geeigneten Format auf der Grundlage des MimeType der hochgeladenen datei.

Eingabedateien:

Es ist möglich, einzelne und mehrere Eingabedateien hochzuladen, sowohl im base64-Format und durch Angabe der Ressourcen-URL und etwaiger authentifizierungsparameter.

  • Beim Hochladen mehrerer Dateien mit PAdES-Signatur hochgeladen werden, werden sie zu einem einzigen signierten pdf dokument zusammengeführt.

  • Wenn Sie mehrere Dateien im CAdES-Format signieren, wird eine Zip datei erzeugt und signiert.

Asynchroner Modus, Stapelverarbeitung, Callback und detached Signatur:

Zum massiven Signieren großer Mengen von Dateien ist es möglich, im asynchronen Modus hochzuladen und zu signieren modus. Ein authentifiziertes Callback-System ist verfügbar, um aktualisierungen.

Es ist auch möglich, den Hash der Originaldatei direkt zu signieren direkt zu signieren und nur die "detached" Signaturdatei zu erhalten.

Aufbewahrung von Dokumenten und Daten im System:

Die strukturierten Daten der Signatur und der Prüfpfad werden im System für maximal 1 Jahr gespeichert. Unterschriebene Dokumente, hochgeladene Dokumente und validierte Dokumente bleiben für maximal 30 Tage im System, um das Herunterladen zu ermöglichen. Nach Ablauf dieser Frist werden die Dokumente automatisch gelöscht.

Qualifizierter Zeitstempel verfügbar:

Es ist eine qualifizierte Zeitstempeloption verfügbar. Es besteht auch die Möglichkeit, qualifizierte Zeitstempel zu verwenden, die Sie bereits besitzen. In diesem Fall können Sie die Authentifizierungs-URL der entsprechenden Zertifizierungsstelle angeben.

Sandbox:

Zu Testzwecken können Sie die folgenden Anmeldedaten verwenden:

  • certificateUsername: "openapiSandboxUsername"
  • certificatePassword: "openapiSandboxPassword"
Authorizations:
bearerAuth
Request Body schema: application/json

Erstellen Sie eine neue massive automatische Signaturanforderung, indem Sie die Eingabedateien und die Zertifikatsnachweise angeben.

Das System kann in den Formaten CAdES, PAdES, XAdES und PKCS#1 signieren. Wenn keine Angaben gemacht werden, sucht das System anhand des MimeType der hochgeladenen Datei nach dem am besten geeigneten Format.

Any of
required
string or string or InputDocumentObject (object) or (Array of strings or strings or InputDocumentObject (object)) (InputDocuments)

Die zu signierenden Eingabedokumente können Sie angeben:

  • ein Dokument als URL (das System wird das Dokument herunterladen und den Mimetyp erraten)
  • eine base64-Zeichenkette einer Datei (der Mimetyp wird vom System erraten)
  • eine base64-Zeichenkette des Hashes (SHA256) einer Datei (das System errät den Mimetyp auf der Grundlage der Hash-Länge von 32)
  • ein Objekt InputDocumentObject mit zusätzlichen Details wie dem "sourceType" des Dokuments, der "url" des Dokuments, den "headers" für die Fernabfrage des Dokuments, der HTTP "method" für die Fernabfrage des Dokuments, den "postData" für die Fernabfrage des Dokuments, der Base64 kodierten "payload" des Dokuments (im Falle von base64 sourceType) oder dem Hash des Dokuments (im Falle von base64Hash sourceType)".
  • ein Array mit einigen der vorherigen Optionen

Hinweise zum Hash der Datei:

Dieses Beispiel zeigt, wie man den Hash der Datei erstellt und ihn in base64 kodiert:

bash openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

Die Ausgabe sieht dann etwa so aus: "msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY="

Das System erkennt, ob es sich bei der base64-Zeichenkette um einen Hash oder eine Datei handelt. Ist die Zeichenkette ein Hash (SHA256==CHAR(32)), signiert das System den Hash der Originaldatei.

Um diese Erkennungsfunktion außer Kraft zu setzen, können Sie das Feld sourceType im Schema InputDocumentObject verwenden.

certificateUsername
required
string

Benutzername für das Zertifikat, muss der Gerätename verwendet werden, den Sie erhalten haben. Er beginnt mit: RHI (/EU-QES_otp), SHI (/EU-QES_eseal) oder AHI (/EU-QES_automatic)

certificatePassword
required
string

Passwort für das Zertifikat, muss die zum Gerätenamen gehörende PIN verwendet werden (kann vom Kunden festgelegt oder in den Blindumschlag eingelesen werden)

certificateOtp
string

GILT NUR FÜR den Endpunkt /EU-QES_otp, ist ERFORDERLICH und kann mit der relativen otp-App von der Zertifizierungsstelle bezogen werden

certificateIdOtp
integer

VALID ONLY FOR /EU-QES_otp endpoint, ist optional und wird verwendet, wenn mehr als ein otp in der Zertifizierungsstellen-App eingestellt ist. Sie finden es im oberen rechten Bereich der otp-App

title
string

Titel der Unterschrift

description
string

Beschreibung der Signatur

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Typ der Unterschrift. Kann sein: cades, pades, xades, pkcs1

object

Zusätzliche Optionen für die Unterschrift. Die verfügbaren Optionen hängen vom Signaturtyp ab:

  • Gemeinsame Optionen:
    • asyncDocumentsValidation" (boolesch): Ob Dokumente asynchron validiert werden sollen. Voreinstellung: false.
    • asyncSignature" (boolesch): Ob Dokumente asynchron signiert werden sollen. Voreinstellung: false.
  • PAdES-Optionen:
    • level (String): Signatur-Stufe. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • encryptInAnyCase" (boolesch): Verschlüsseln in jedem Fall. Voreinstellung: false.
    • seite" (ganze Zahl): Zu signierende Seitennummer. Voreinstellung: 1.
    • verschlüsselungsPasswort" (String): Passwort für die PDF-Verschlüsselung. Voreinstellung: null.
    • unterzeichnerBild" (String): Bild des Unterzeichners. Voreinstellung: null.
    • lockFields" (Zeichenkette): Zu sperrende Felder. Voreinstellung: null.
    • withSignatureField" (boolesch): Signaturfeld einbeziehen. Voreinstellung: false.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • CAdES Optionen:
    • detached (boolesch): Getrennte Signatur. Voreinstellung: false.
    • level" (Zeichenkette): Unterschriftsebene. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • zählerSignatur" (boolesch): Zähler-Signatur. Voreinstellung: false.
    • withTimestamp(boolesch): Zeitstempel einbeziehen. Voreinstellung:false`.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • XAdES Optionen:
    • level (String): Signatur-Level. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • detached" (boolesch): Getrennte Signatur. Voreinstellung: false.
    • withoutSignatureExclusion (boolesch): Ohne Ausschluss der Signatur. Voreinstellung: false.
    • xPathQuery" (Zeichenkette): XPath-Abfrage. Voreinstellung: null.
    • signElement" (Zeichenkette): Vorzeichen-Element. Voreinstellung: null.
    • unterschriftId" (String): Unterschriften-ID. Voreinstellung: null.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (String): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • PKCS1 Optionen:
    • hashAlgorithmus (String): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
Any of
required
string or string or InputDocumentObject (object) or (Array of strings or strings or InputDocumentObject (object)) (InputDocuments)

Die zu signierenden Eingabedokumente können Sie angeben:

  • ein Dokument als URL (das System wird das Dokument herunterladen und den Mimetyp erraten)
  • eine base64-Zeichenkette einer Datei (der Mimetyp wird vom System erraten)
  • eine base64-Zeichenkette des Hashes (SHA256) einer Datei (das System errät den Mimetyp auf der Grundlage der Hash-Länge von 32)
  • ein Objekt InputDocumentObject mit zusätzlichen Details wie dem "sourceType" des Dokuments, der "url" des Dokuments, den "headers" für die Fernabfrage des Dokuments, der HTTP "method" für die Fernabfrage des Dokuments, den "postData" für die Fernabfrage des Dokuments, der Base64 kodierten "payload" des Dokuments (im Falle von base64 sourceType) oder dem Hash des Dokuments (im Falle von base64Hash sourceType)".
  • ein Array mit einigen der vorherigen Optionen

Hinweise zum Hash der Datei:

Dieses Beispiel zeigt, wie man den Hash der Datei erstellt und ihn in base64 kodiert:

bash openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

Die Ausgabe sieht dann etwa so aus: "msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY="

Das System erkennt, ob es sich bei der base64-Zeichenkette um einen Hash oder eine Datei handelt. Ist die Zeichenkette ein Hash (SHA256==CHAR(32)), signiert das System den Hash der Originaldatei.

Um diese Erkennungsfunktion außer Kraft zu setzen, können Sie das Feld sourceType im Schema InputDocumentObject verwenden.

certificateUsername
required
string

Benutzername für das Zertifikat, muss der Gerätename verwendet werden, den Sie erhalten haben. Er beginnt mit: RHI (/EU-QES_otp), SHI (/EU-QES_eseal) oder AHI (/EU-QES_automatic)

certificatePassword
required
string

Passwort für das Zertifikat, muss die zum Gerätenamen gehörende PIN verwendet werden (kann vom Kunden festgelegt oder in den Blindumschlag eingelesen werden)

certificateOtp
string

GILT NUR FÜR den Endpunkt /EU-QES_otp, ist ERFORDERLICH und kann mit der relativen otp-App von der Zertifizierungsstelle bezogen werden

certificateIdOtp
integer

VALID ONLY FOR /EU-QES_otp endpoint, ist optional und wird verwendet, wenn mehr als ein otp in der Zertifizierungsstellen-App eingestellt ist. Sie finden es im oberen rechten Bereich der otp-App

title
string

Titel der Unterschrift

description
string

Beschreibung der Signatur

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Typ der Unterschrift. Kann sein: cades, pades, xades, pkcs1

object

Zusätzliche Optionen für die Unterschrift. Die verfügbaren Optionen hängen vom Signaturtyp ab:

  • Gemeinsame Optionen:
    • asyncDocumentsValidation" (boolesch): Ob Dokumente asynchron validiert werden sollen. Voreinstellung: false.
    • asyncSignature" (boolesch): Ob Dokumente asynchron signiert werden sollen. Voreinstellung: false.
  • PAdES-Optionen:
    • level (String): Signatur-Stufe. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • encryptInAnyCase" (boolesch): Verschlüsseln in jedem Fall. Voreinstellung: false.
    • seite" (ganze Zahl): Zu signierende Seitennummer. Voreinstellung: 1.
    • verschlüsselungsPasswort" (String): Passwort für die PDF-Verschlüsselung. Voreinstellung: null.
    • unterzeichnerBild" (String): Bild des Unterzeichners. Voreinstellung: null.
    • lockFields" (Zeichenkette): Zu sperrende Felder. Voreinstellung: null.
    • withSignatureField" (boolesch): Signaturfeld einbeziehen. Voreinstellung: false.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • CAdES Optionen:
    • detached (boolesch): Getrennte Signatur. Voreinstellung: false.
    • level" (Zeichenkette): Unterschriftsebene. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • zählerSignatur" (boolesch): Zähler-Signatur. Voreinstellung: false.
    • withTimestamp(boolesch): Zeitstempel einbeziehen. Voreinstellung:false`.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • XAdES Optionen:
    • level (String): Signatur-Level. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • detached" (boolesch): Getrennte Signatur. Voreinstellung: false.
    • withoutSignatureExclusion (boolesch): Ohne Ausschluss der Signatur. Voreinstellung: false.
    • xPathQuery" (Zeichenkette): XPath-Abfrage. Voreinstellung: null.
    • signElement" (Zeichenkette): Vorzeichen-Element. Voreinstellung: null.
    • unterschriftId" (String): Unterschriften-ID. Voreinstellung: null.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (String): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • PKCS1 Optionen:
    • hashAlgorithmus (String): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Callbacks

Request samples

Content type
application/json
Example
{
  • "inputDocuments": [
    ],
  • "certificateUsername": "openapiSandboxUsername",
  • "certificatePassword": "openapiSandboxPassword",
  • "title": "CAdES Signature",
  • "description": "CAdES-Signatur einer base64-Datei",
  • "signatureType": "cades"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "message": "Created",
  • "success": true,
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/callback/url}
Content type
{
  • "data": {
    },
  • "custom": {
    }
}

QES-Signatur mit Remote-OTP-Zertifikat erstellen

Erstellen Sie ein Signaturverfahren aus einer oder mehreren Dateien.

Beschaffung des Zertifikats:

Um auf den Dienst zugreifen zu können, benötigen Sie ein automatisches Zertifikat, das Sie über den entsprechenden Endpunkt /certificates/namirial-otp erworben werden kann.

Verfügbare Formate:

Das System kann in den Formaten CAdES, PAdES, XAdES und PKCS#1 signieren.

Wenn nicht angegeben, sucht das System nach dem am besten geeigneten Format auf der Grundlage des MimeType der hochgeladenen datei.

Eingabedateien:

Es ist möglich, einzelne und mehrere Eingabedateien hochzuladen, sowohl im base64-Format und durch Angabe der Ressourcen-URL und etwaiger authentifizierungsparameter.

  • Beim Hochladen mehrerer Dateien mit PAdES-Signatur hochgeladen werden, werden sie zu einem einzigen signierten pdf dokument zusammengeführt.

  • Wenn Sie mehrere Dateien im CAdES-Format signieren, wird eine Zip datei erzeugt und signiert.

Asynchroner Modus, Stapelverarbeitung, Callback und detached Signatur:

Zum massiven Signieren großer Mengen von Dateien ist es möglich, im asynchronen Modus hochzuladen und zu signieren modus. Ein authentifiziertes Callback-System ist verfügbar, um aktualisierungen.

Es ist auch möglich, den Hash der Originaldatei direkt zu signieren direkt zu signieren und nur die "detached" Signaturdatei zu erhalten.

Aufbewahrung von Dokumenten und Daten im System:

Die strukturierten Daten der Signatur und der Prüfpfad werden im System für maximal 1 Jahr gespeichert. Unterschriebene Dokumente, hochgeladene Dokumente und validierte Dokumente bleiben für maximal 30 Tage im System, um das Herunterladen zu ermöglichen. Nach Ablauf dieser Frist werden die Dokumente automatisch gelöscht.

Qualifizierter Zeitstempel verfügbar:

Es ist eine qualifizierte Zeitstempeloption verfügbar. Es besteht auch die Möglichkeit, qualifizierte Zeitstempel zu verwenden, die Sie bereits besitzen. In diesem Fall können Sie die Authentifizierungs-URL der entsprechenden Zertifizierungsstelle angeben.

Sandbox:

Zu Testzwecken können Sie die folgenden Anmeldedaten verwenden:

  • certificateUsername: "openapiSandboxUsername"
  • certificatePassword: "openapiSandboxPassword"
Authorizations:
bearerAuth
Request Body schema: application/json

Erstellen Sie eine neue massive automatische Signaturanforderung, indem Sie die Eingabedateien und die Zertifikatsnachweise angeben.

Das System kann in den Formaten CAdES, PAdES, XAdES und PKCS#1 signieren. Wenn keine Angaben gemacht werden, sucht das System anhand des MimeType der hochgeladenen Datei nach dem am besten geeigneten Format.

Any of
required
string or string or InputDocumentObject (object) or (Array of strings or strings or InputDocumentObject (object)) (InputDocuments)

Die zu signierenden Eingabedokumente können Sie angeben:

  • ein Dokument als URL (das System wird das Dokument herunterladen und den Mimetyp erraten)
  • eine base64-Zeichenkette einer Datei (der Mimetyp wird vom System erraten)
  • eine base64-Zeichenkette des Hashes (SHA256) einer Datei (das System errät den Mimetyp auf der Grundlage der Hash-Länge von 32)
  • ein Objekt InputDocumentObject mit zusätzlichen Details wie dem "sourceType" des Dokuments, der "url" des Dokuments, den "headers" für die Fernabfrage des Dokuments, der HTTP "method" für die Fernabfrage des Dokuments, den "postData" für die Fernabfrage des Dokuments, der Base64 kodierten "payload" des Dokuments (im Falle von base64 sourceType) oder dem Hash des Dokuments (im Falle von base64Hash sourceType)".
  • ein Array mit einigen der vorherigen Optionen

Hinweise zum Hash der Datei:

Dieses Beispiel zeigt, wie man den Hash der Datei erstellt und ihn in base64 kodiert:

bash openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

Die Ausgabe sieht dann etwa so aus: "msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY="

Das System erkennt, ob es sich bei der base64-Zeichenkette um einen Hash oder eine Datei handelt. Ist die Zeichenkette ein Hash (SHA256==CHAR(32)), signiert das System den Hash der Originaldatei.

Um diese Erkennungsfunktion außer Kraft zu setzen, können Sie das Feld sourceType im Schema InputDocumentObject verwenden.

certificateUsername
required
string

Benutzername für das Zertifikat, muss der Gerätename verwendet werden, den Sie erhalten haben. Er beginnt mit: RHI (/EU-QES_otp), SHI (/EU-QES_eseal) oder AHI (/EU-QES_automatic)

certificatePassword
required
string

Passwort für das Zertifikat, muss die zum Gerätenamen gehörende PIN verwendet werden (kann vom Kunden festgelegt oder in den Blindumschlag eingelesen werden)

certificateOtp
string

GILT NUR FÜR den Endpunkt /EU-QES_otp, ist ERFORDERLICH und kann mit der relativen otp-App von der Zertifizierungsstelle bezogen werden

certificateIdOtp
integer

VALID ONLY FOR /EU-QES_otp endpoint, ist optional und wird verwendet, wenn mehr als ein otp in der Zertifizierungsstellen-App eingestellt ist. Sie finden es im oberen rechten Bereich der otp-App

title
string

Titel der Unterschrift

description
string

Beschreibung der Signatur

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Typ der Unterschrift. Kann sein: cades, pades, xades, pkcs1

object

Zusätzliche Optionen für die Unterschrift. Die verfügbaren Optionen hängen vom Signaturtyp ab:

  • Gemeinsame Optionen:
    • asyncDocumentsValidation" (boolesch): Ob Dokumente asynchron validiert werden sollen. Voreinstellung: false.
    • asyncSignature" (boolesch): Ob Dokumente asynchron signiert werden sollen. Voreinstellung: false.
  • PAdES-Optionen:
    • level (String): Signatur-Stufe. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • encryptInAnyCase" (boolesch): Verschlüsseln in jedem Fall. Voreinstellung: false.
    • seite" (ganze Zahl): Zu signierende Seitennummer. Voreinstellung: 1.
    • verschlüsselungsPasswort" (String): Passwort für die PDF-Verschlüsselung. Voreinstellung: null.
    • unterzeichnerBild" (String): Bild des Unterzeichners. Voreinstellung: null.
    • lockFields" (Zeichenkette): Zu sperrende Felder. Voreinstellung: null.
    • withSignatureField" (boolesch): Signaturfeld einbeziehen. Voreinstellung: false.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • CAdES Optionen:
    • detached (boolesch): Getrennte Signatur. Voreinstellung: false.
    • level" (Zeichenkette): Unterschriftsebene. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • zählerSignatur" (boolesch): Zähler-Signatur. Voreinstellung: false.
    • withTimestamp(boolesch): Zeitstempel einbeziehen. Voreinstellung:false`.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • XAdES Optionen:
    • level (String): Signatur-Level. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • detached" (boolesch): Getrennte Signatur. Voreinstellung: false.
    • withoutSignatureExclusion (boolesch): Ohne Ausschluss der Signatur. Voreinstellung: false.
    • xPathQuery" (Zeichenkette): XPath-Abfrage. Voreinstellung: null.
    • signElement" (Zeichenkette): Vorzeichen-Element. Voreinstellung: null.
    • unterschriftId" (String): Unterschriften-ID. Voreinstellung: null.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (String): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • PKCS1 Optionen:
    • hashAlgorithmus (String): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
Any of
required
string or string or InputDocumentObject (object) or (Array of strings or strings or InputDocumentObject (object)) (InputDocuments)

Die zu signierenden Eingabedokumente können Sie angeben:

  • ein Dokument als URL (das System wird das Dokument herunterladen und den Mimetyp erraten)
  • eine base64-Zeichenkette einer Datei (der Mimetyp wird vom System erraten)
  • eine base64-Zeichenkette des Hashes (SHA256) einer Datei (das System errät den Mimetyp auf der Grundlage der Hash-Länge von 32)
  • ein Objekt InputDocumentObject mit zusätzlichen Details wie dem "sourceType" des Dokuments, der "url" des Dokuments, den "headers" für die Fernabfrage des Dokuments, der HTTP "method" für die Fernabfrage des Dokuments, den "postData" für die Fernabfrage des Dokuments, der Base64 kodierten "payload" des Dokuments (im Falle von base64 sourceType) oder dem Hash des Dokuments (im Falle von base64Hash sourceType)".
  • ein Array mit einigen der vorherigen Optionen

Hinweise zum Hash der Datei:

Dieses Beispiel zeigt, wie man den Hash der Datei erstellt und ihn in base64 kodiert:

bash openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

Die Ausgabe sieht dann etwa so aus: "msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY="

Das System erkennt, ob es sich bei der base64-Zeichenkette um einen Hash oder eine Datei handelt. Ist die Zeichenkette ein Hash (SHA256==CHAR(32)), signiert das System den Hash der Originaldatei.

Um diese Erkennungsfunktion außer Kraft zu setzen, können Sie das Feld sourceType im Schema InputDocumentObject verwenden.

certificateUsername
required
string

Benutzername für das Zertifikat, muss der Gerätename verwendet werden, den Sie erhalten haben. Er beginnt mit: RHI (/EU-QES_otp), SHI (/EU-QES_eseal) oder AHI (/EU-QES_automatic)

certificatePassword
required
string

Passwort für das Zertifikat, muss die zum Gerätenamen gehörende PIN verwendet werden (kann vom Kunden festgelegt oder in den Blindumschlag eingelesen werden)

certificateOtp
string

GILT NUR FÜR den Endpunkt /EU-QES_otp, ist ERFORDERLICH und kann mit der relativen otp-App von der Zertifizierungsstelle bezogen werden

certificateIdOtp
integer

VALID ONLY FOR /EU-QES_otp endpoint, ist optional und wird verwendet, wenn mehr als ein otp in der Zertifizierungsstellen-App eingestellt ist. Sie finden es im oberen rechten Bereich der otp-App

title
string

Titel der Unterschrift

description
string

Beschreibung der Signatur

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Typ der Unterschrift. Kann sein: cades, pades, xades, pkcs1

object

Zusätzliche Optionen für die Unterschrift. Die verfügbaren Optionen hängen vom Signaturtyp ab:

  • Gemeinsame Optionen:
    • asyncDocumentsValidation" (boolesch): Ob Dokumente asynchron validiert werden sollen. Voreinstellung: false.
    • asyncSignature" (boolesch): Ob Dokumente asynchron signiert werden sollen. Voreinstellung: false.
  • PAdES-Optionen:
    • level (String): Signatur-Stufe. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • encryptInAnyCase" (boolesch): Verschlüsseln in jedem Fall. Voreinstellung: false.
    • seite" (ganze Zahl): Zu signierende Seitennummer. Voreinstellung: 1.
    • verschlüsselungsPasswort" (String): Passwort für die PDF-Verschlüsselung. Voreinstellung: null.
    • unterzeichnerBild" (String): Bild des Unterzeichners. Voreinstellung: null.
    • lockFields" (Zeichenkette): Zu sperrende Felder. Voreinstellung: null.
    • withSignatureField" (boolesch): Signaturfeld einbeziehen. Voreinstellung: false.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • CAdES Optionen:
    • detached (boolesch): Getrennte Signatur. Voreinstellung: false.
    • level" (Zeichenkette): Unterschriftsebene. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • zählerSignatur" (boolesch): Zähler-Signatur. Voreinstellung: false.
    • withTimestamp(boolesch): Zeitstempel einbeziehen. Voreinstellung:false`.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • XAdES Optionen:
    • level (String): Signatur-Level. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • detached" (boolesch): Getrennte Signatur. Voreinstellung: false.
    • withoutSignatureExclusion (boolesch): Ohne Ausschluss der Signatur. Voreinstellung: false.
    • xPathQuery" (Zeichenkette): XPath-Abfrage. Voreinstellung: null.
    • signElement" (Zeichenkette): Vorzeichen-Element. Voreinstellung: null.
    • unterschriftId" (String): Unterschriften-ID. Voreinstellung: null.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (String): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • PKCS1 Optionen:
    • hashAlgorithmus (String): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Callbacks

Request samples

Content type
application/json
Example
{
  • "inputDocuments": [
    ],
  • "certificateUsername": "openapiSandboxUsername",
  • "certificatePassword": "openapiSandboxPassword",
  • "certificateOtp": "123456",
  • "certificateIdOtp": -1,
  • "title": "CAdES Signature",
  • "description": "CAdES-Signatur einer base64-Datei",
  • "signatureType": "cades"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "message": "Created",
  • "success": true,
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/callback/url}
Content type
{
  • "data": {
    },
  • "custom": {
    }
}

QES-Signatur mit E-Siegel-Fernzertifikat erstellen

Erstellen Sie ein Signaturverfahren aus einer oder mehreren Dateien.

Beschaffung des Zertifikats:

Um auf den Dienst zugreifen zu können, benötigen Sie ein automatisches Zertifikat, das Sie über Unsere Kundenbetreuung erworben werden kann.

Verfügbare Formate:

Das System kann in den Formaten CAdES, PAdES, XAdES und PKCS#1 signieren.

Wenn nicht angegeben, sucht das System nach dem am besten geeigneten Format auf der Grundlage des MimeType der hochgeladenen datei.

Eingabedateien:

Es ist möglich, einzelne und mehrere Eingabedateien hochzuladen, sowohl im base64-Format und durch Angabe der Ressourcen-URL und etwaiger authentifizierungsparameter.

  • Beim Hochladen mehrerer Dateien mit PAdES-Signatur hochgeladen werden, werden sie zu einem einzigen signierten pdf dokument zusammengeführt.

  • Wenn Sie mehrere Dateien im CAdES-Format signieren, wird eine Zip datei erzeugt und signiert.

Asynchroner Modus, Stapelverarbeitung, Callback und detached Signatur:

Zum massiven Signieren großer Mengen von Dateien ist es möglich, im asynchronen Modus hochzuladen und zu signieren modus. Ein authentifiziertes Callback-System ist verfügbar, um aktualisierungen.

Es ist auch möglich, den Hash der Originaldatei direkt zu signieren direkt zu signieren und nur die "detached" Signaturdatei zu erhalten.

Aufbewahrung von Dokumenten und Daten im System:

Die strukturierten Daten der Signatur und der Prüfpfad werden im System für maximal 1 Jahr gespeichert. Unterschriebene Dokumente, hochgeladene Dokumente und validierte Dokumente bleiben für maximal 30 Tage im System, um das Herunterladen zu ermöglichen. Nach Ablauf dieser Frist werden die Dokumente automatisch gelöscht.

Qualifizierter Zeitstempel verfügbar:

Es ist eine qualifizierte Zeitstempeloption verfügbar. Es besteht auch die Möglichkeit, qualifizierte Zeitstempel zu verwenden, die Sie bereits besitzen. In diesem Fall können Sie die Authentifizierungs-URL der entsprechenden Zertifizierungsstelle angeben.

Sandbox:

Zu Testzwecken können Sie die folgenden Anmeldedaten verwenden:

  • certificateUsername: "openapiSandboxUsername"
  • certificatePassword: "openapiSandboxPassword"
Authorizations:
bearerAuth
Request Body schema: application/json

Erstellen Sie eine neue massive automatische Signaturanforderung, indem Sie die Eingabedateien und die Zertifikatsnachweise angeben.

Das System kann in den Formaten CAdES, PAdES, XAdES und PKCS#1 signieren. Wenn keine Angaben gemacht werden, sucht das System anhand des MimeType der hochgeladenen Datei nach dem am besten geeigneten Format.

Any of
required
string or string or InputDocumentObject (object) or (Array of strings or strings or InputDocumentObject (object)) (InputDocuments)

Die zu signierenden Eingabedokumente können Sie angeben:

  • ein Dokument als URL (das System wird das Dokument herunterladen und den Mimetyp erraten)
  • eine base64-Zeichenkette einer Datei (der Mimetyp wird vom System erraten)
  • eine base64-Zeichenkette des Hashes (SHA256) einer Datei (das System errät den Mimetyp auf der Grundlage der Hash-Länge von 32)
  • ein Objekt InputDocumentObject mit zusätzlichen Details wie dem "sourceType" des Dokuments, der "url" des Dokuments, den "headers" für die Fernabfrage des Dokuments, der HTTP "method" für die Fernabfrage des Dokuments, den "postData" für die Fernabfrage des Dokuments, der Base64 kodierten "payload" des Dokuments (im Falle von base64 sourceType) oder dem Hash des Dokuments (im Falle von base64Hash sourceType)".
  • ein Array mit einigen der vorherigen Optionen

Hinweise zum Hash der Datei:

Dieses Beispiel zeigt, wie man den Hash der Datei erstellt und ihn in base64 kodiert:

bash openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

Die Ausgabe sieht dann etwa so aus: "msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY="

Das System erkennt, ob es sich bei der base64-Zeichenkette um einen Hash oder eine Datei handelt. Ist die Zeichenkette ein Hash (SHA256==CHAR(32)), signiert das System den Hash der Originaldatei.

Um diese Erkennungsfunktion außer Kraft zu setzen, können Sie das Feld sourceType im Schema InputDocumentObject verwenden.

certificateUsername
required
string

Benutzername für das Zertifikat, muss der Gerätename verwendet werden, den Sie erhalten haben. Er beginnt mit: RHI (/EU-QES_otp), SHI (/EU-QES_eseal) oder AHI (/EU-QES_automatic)

certificatePassword
required
string

Passwort für das Zertifikat, muss die zum Gerätenamen gehörende PIN verwendet werden (kann vom Kunden festgelegt oder in den Blindumschlag eingelesen werden)

certificateOtp
string

GILT NUR FÜR den Endpunkt /EU-QES_otp, ist ERFORDERLICH und kann mit der relativen otp-App von der Zertifizierungsstelle bezogen werden

certificateIdOtp
integer

VALID ONLY FOR /EU-QES_otp endpoint, ist optional und wird verwendet, wenn mehr als ein otp in der Zertifizierungsstellen-App eingestellt ist. Sie finden es im oberen rechten Bereich der otp-App

title
string

Titel der Unterschrift

description
string

Beschreibung der Signatur

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Typ der Unterschrift. Kann sein: cades, pades, xades, pkcs1

object

Zusätzliche Optionen für die Unterschrift. Die verfügbaren Optionen hängen vom Signaturtyp ab:

  • Gemeinsame Optionen:
    • asyncDocumentsValidation" (boolesch): Ob Dokumente asynchron validiert werden sollen. Voreinstellung: false.
    • asyncSignature" (boolesch): Ob Dokumente asynchron signiert werden sollen. Voreinstellung: false.
  • PAdES-Optionen:
    • level (String): Signatur-Stufe. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • encryptInAnyCase" (boolesch): Verschlüsseln in jedem Fall. Voreinstellung: false.
    • seite" (ganze Zahl): Zu signierende Seitennummer. Voreinstellung: 1.
    • verschlüsselungsPasswort" (String): Passwort für die PDF-Verschlüsselung. Voreinstellung: null.
    • unterzeichnerBild" (String): Bild des Unterzeichners. Voreinstellung: null.
    • lockFields" (Zeichenkette): Zu sperrende Felder. Voreinstellung: null.
    • withSignatureField" (boolesch): Signaturfeld einbeziehen. Voreinstellung: false.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • CAdES Optionen:
    • detached (boolesch): Getrennte Signatur. Voreinstellung: false.
    • level" (Zeichenkette): Unterschriftsebene. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • zählerSignatur" (boolesch): Zähler-Signatur. Voreinstellung: false.
    • withTimestamp(boolesch): Zeitstempel einbeziehen. Voreinstellung:false`.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • XAdES Optionen:
    • level (String): Signatur-Level. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • detached" (boolesch): Getrennte Signatur. Voreinstellung: false.
    • withoutSignatureExclusion (boolesch): Ohne Ausschluss der Signatur. Voreinstellung: false.
    • xPathQuery" (Zeichenkette): XPath-Abfrage. Voreinstellung: null.
    • signElement" (Zeichenkette): Vorzeichen-Element. Voreinstellung: null.
    • unterschriftId" (String): Unterschriften-ID. Voreinstellung: null.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (String): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • PKCS1 Optionen:
    • hashAlgorithmus (String): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Responses

Response Schema: application/json
Any of
required
string or string or InputDocumentObject (object) or (Array of strings or strings or InputDocumentObject (object)) (InputDocuments)

Die zu signierenden Eingabedokumente können Sie angeben:

  • ein Dokument als URL (das System wird das Dokument herunterladen und den Mimetyp erraten)
  • eine base64-Zeichenkette einer Datei (der Mimetyp wird vom System erraten)
  • eine base64-Zeichenkette des Hashes (SHA256) einer Datei (das System errät den Mimetyp auf der Grundlage der Hash-Länge von 32)
  • ein Objekt InputDocumentObject mit zusätzlichen Details wie dem "sourceType" des Dokuments, der "url" des Dokuments, den "headers" für die Fernabfrage des Dokuments, der HTTP "method" für die Fernabfrage des Dokuments, den "postData" für die Fernabfrage des Dokuments, der Base64 kodierten "payload" des Dokuments (im Falle von base64 sourceType) oder dem Hash des Dokuments (im Falle von base64Hash sourceType)".
  • ein Array mit einigen der vorherigen Optionen

Hinweise zum Hash der Datei:

Dieses Beispiel zeigt, wie man den Hash der Datei erstellt und ihn in base64 kodiert:

bash openssl dgst -sha256 -binary FILE_TO_BE_SIGN | openssl enc -a

Die Ausgabe sieht dann etwa so aus: "msj3f4hJCSELbMkWjkFwNrf0XhkebTnAKaKhx4686DY="

Das System erkennt, ob es sich bei der base64-Zeichenkette um einen Hash oder eine Datei handelt. Ist die Zeichenkette ein Hash (SHA256==CHAR(32)), signiert das System den Hash der Originaldatei.

Um diese Erkennungsfunktion außer Kraft zu setzen, können Sie das Feld sourceType im Schema InputDocumentObject verwenden.

certificateUsername
required
string

Benutzername für das Zertifikat, muss der Gerätename verwendet werden, den Sie erhalten haben. Er beginnt mit: RHI (/EU-QES_otp), SHI (/EU-QES_eseal) oder AHI (/EU-QES_automatic)

certificatePassword
required
string

Passwort für das Zertifikat, muss die zum Gerätenamen gehörende PIN verwendet werden (kann vom Kunden festgelegt oder in den Blindumschlag eingelesen werden)

certificateOtp
string

GILT NUR FÜR den Endpunkt /EU-QES_otp, ist ERFORDERLICH und kann mit der relativen otp-App von der Zertifizierungsstelle bezogen werden

certificateIdOtp
integer

VALID ONLY FOR /EU-QES_otp endpoint, ist optional und wird verwendet, wenn mehr als ein otp in der Zertifizierungsstellen-App eingestellt ist. Sie finden es im oberen rechten Bereich der otp-App

title
string

Titel der Unterschrift

description
string

Beschreibung der Signatur

signatureType
string
Enum: "cades" "pades" "xades" "pkcs1"

Typ der Unterschrift. Kann sein: cades, pades, xades, pkcs1

object

Zusätzliche Optionen für die Unterschrift. Die verfügbaren Optionen hängen vom Signaturtyp ab:

  • Gemeinsame Optionen:
    • asyncDocumentsValidation" (boolesch): Ob Dokumente asynchron validiert werden sollen. Voreinstellung: false.
    • asyncSignature" (boolesch): Ob Dokumente asynchron signiert werden sollen. Voreinstellung: false.
  • PAdES-Optionen:
    • level (String): Signatur-Stufe. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • encryptInAnyCase" (boolesch): Verschlüsseln in jedem Fall. Voreinstellung: false.
    • seite" (ganze Zahl): Zu signierende Seitennummer. Voreinstellung: 1.
    • verschlüsselungsPasswort" (String): Passwort für die PDF-Verschlüsselung. Voreinstellung: null.
    • unterzeichnerBild" (String): Bild des Unterzeichners. Voreinstellung: null.
    • lockFields" (Zeichenkette): Zu sperrende Felder. Voreinstellung: null.
    • withSignatureField" (boolesch): Signaturfeld einbeziehen. Voreinstellung: false.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • CAdES Optionen:
    • detached (boolesch): Getrennte Signatur. Voreinstellung: false.
    • level" (Zeichenkette): Unterschriftsebene. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • zählerSignatur" (boolesch): Zähler-Signatur. Voreinstellung: false.
    • withTimestamp(boolesch): Zeitstempel einbeziehen. Voreinstellung:false`.
    • timestampUrl" (Zeichenkette): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • XAdES Optionen:
    • level (String): Signatur-Level. Werte: B, T, LT, LTA, LTV. Voreinstellung: B.
    • hashAlgorithmus (Zeichenkette): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
    • detached" (boolesch): Getrennte Signatur. Voreinstellung: false.
    • withoutSignatureExclusion (boolesch): Ohne Ausschluss der Signatur. Voreinstellung: false.
    • xPathQuery" (Zeichenkette): XPath-Abfrage. Voreinstellung: null.
    • signElement" (Zeichenkette): Vorzeichen-Element. Voreinstellung: null.
    • unterschriftId" (String): Unterschriften-ID. Voreinstellung: null.
    • withTimestamp" (boolesch): Zeitstempel einbeziehen. Voreinstellung: false.
    • timestampUrl" (String): URL des Zeitstempeldienstes. Voreinstellung: null.
    • timestampUsername" (String): Benutzername für den Zeitstempeldienst. Voreinstellung: null.
    • zeitstempelPasswort" (Zeichenkette): Passwort für den Zeitstempeldienst. Voreinstellung: null.
    • timestampHashAlgo" (Zeichenkette): Hash-Algorithmus für den Zeitstempeldienst. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
  • PKCS1 Optionen:
    • hashAlgorithmus (String): Hash-Algorithmus. Werte: SHA1, SHA256, SHA384, SHA512. Voreinstellung: SHA256.
object (Callback)

Dies ist unser standardisiertes OpenAPI-Callback-System. Es ermöglicht die Konfiguration von Parametern für den Empfang von Benachrichtigungen über Statusaktualisierungen von asynchronen Anfragen an diesen Endpunkt.

Callbacks

Request samples

Content type
application/json
Example
{
  • "inputDocuments": [
    ],
  • "certificateUsername": "openapiSandboxUsername",
  • "certificatePassword": "openapiSandboxPassword",
  • "title": "CAdES Signature",
  • "description": "CAdES-Signatur einer base64-Datei",
  • "signatureType": "cades"
}

Response samples

Content type
application/json
Example
{
  • "data": {
    },
  • "message": "Created",
  • "success": true,
  • "error": null
}

Callback payload samples

Callback
POST: {$request.body#/callback/url}
Content type
{
  • "data": {
    },
  • "custom": {
    }
}

Eine Unterschrift prüfen

Überprüfen Sie eine Signatur, indem Sie das signierte Dokument hochladen. Das System gibt das Ergebnis der Überprüfung zurück.

Authorizations:
bearerAuth
Request Body schema: application/json

Überprüfen Sie eine Signatur, indem Sie das signierte Dokument hochladen.

inputDocument
required
string <base64>

Unterzeichnetes Dokument

detachedContent
string <base64>

Detached" Inhalt

pdfEncryptionPassword
string

Passwort für pdf-Verschlüsselung

recursive
boolean

Rekursive Überprüfung

verifyOnDate
string <date>

Datum zur Überprüfung der Unterschrift

Responses

Response Schema: application/json
object

Ergebnis der Überprüfung

message
string

Nachricht

error
string or null

Fehlercode

success
boolean

Erfolgreiche Operation

Request samples

Content type
application/json
{
  • "inputDocument": "BASE64string",
  • "detachedContent": "BASE64string",
  • "pdfEncryptionPassword": "password123",
  • "recursive": true,
  • "verifyOnDate": "2025-02-14"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Signature is valid",
  • "error": "",
  • "success": true
}

Löschen des signierten Dokuments, der Details, des Audit Trail und des validierten Dokuments einer Signatur

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: 67af24c5af9b55291406e946

ID der Unterschrift

Responses

Request samples 

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "https://esignature.openapi.com/signatures/67af24c5af9b55291406e946");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);
Web Service Revision: 2.0.0