HilfezentrumIntegrationen

Für: Administratoren

Mit einem Hub-Schlüssel können Sie elektronische Signaturen senden und lesen.

Erstellen Sie eine elektronische Signatur für einen Fall anhand einer Vorlage, wählen Sie aus, wer welches Feld unterschreibt, veröffentlichen Sie ihn zur Unterzeichnung und laden Sie die gesperrte Kopie herunter, sobald alle unterschrieben haben.

In diesem Artikel9 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt die Übertragung von e-SignaturesE-Signatur Ein zur elektronischen Signatur gesendetes Dokument, das im Browser signiert wurde. sowie die Verwendung einer Hub-Schlüssel zur Verarbeitung dieser Signatures. Die Wege zur Erreichung dieser Ziele sind unter https://prd-api-app.caseactive.com/v1/<hub id>/<case id> angegeben.

Anrufe

AnrufWas es tut
GET /signs/templatesListe der e-Sign-Templates
POST /signsErstellt eine elektronische Version des Dokuments – allerdings noch nicht veröffentlicht.
PUT /signs/<sign_id>/schemaWählt aus, wer jedes Feld unterschreibt.
PUT /signs/<sign_id>Es wird der Name, die Veröffentlichungsdatum oder die Benachrichtigungen vor der Veröffentlichung geändert.
PUT /signs/<sign_id>/publishEs wird veröffentlicht – und anschließend an die Unterzeichner gesendet.
GET /signs?filter=allListet die elektronischen Dokumente des Falles auf.
GET /signs/<sign_id>Liest eine elektronische Signatur – zusammen mit deren Status.
DELETE /signs/<sign_id>Löschen Sie es – zusammen mit seinen Signaten.
GET /signs/<sign_id>/responsesListet seine Signaturn auf.
GET /signs/<sign_id>/responses/<response_id>Liest eine Signatur

Eine elektronische Signatur wird schrittweise ausgegeben: Zuerst wird sie erstellt, anschließend wird überprüft, wer jedes Feld signiert. Danach wird die Signatur veröffentlicht. Bis zur Veröffentlichung können die Signatare die Signatur nicht sehen – niemand wird davon informiert. Sobald die Signatur veröffentlicht ist, kann nichts mehr daran geändert werden.

Erstellung einer elektronischen Signatur

GET /signs/templates listet die veröffentlichten e-Sign-vorlagenVorlage Ein wiederverwendbarer Feed-Beitrag, ein Formular, eine elektronische Signatur, eine Notiz oder eine Aufgabe, die in der Bibliothek aufbewahrt und in Fälle kopiert wird. auf. Die Vorlagen werden in der Reihenfolge ihrer Altersstufe angezeigt. Für jede Vorlage sind die Werte asset_id, title, description, due_mins bekannt – das bedeutet, wie viele Minuten nach dem Versand die Vorlage fällig ist. Zudem werden die Werte notifications und role_field_participants angezeigt. Diese Werte geben an, welche Rolle für das Unterzeichnen jedes Feldes vorgesehen ist.

POST /signs akzeptiert Folgendes als Eingabe:

FeldWas es tutErforderlichStandard
nameDer Titel des elektronischen Dokuments besteht aus Buchstaben, Zahlen, Leerzeichen und dem Symbol „& ' - _ ( ) . /“. Es gibt keine Kommas oder Kolonnen.Ja.–
duration{"due_date": "2026-10-09T17:00:00-04:00"} – inklusive der Zeitzonenverschiebung. E-Signs wiederholen sich nicht; eine Wiederholungsregel wird daher abgelehnt.Ja.–
template{"owner": "host", "template_id": "<asset_id>"} Verwendung des Dokuments sowie der Unterschrifter einesTemplates.Nein.Keine.
descriptionEine Notiz, die mit der elektronischen Signatur versehen ist.Nein.Das Template…
notificationsErinnerungen: {"names": ["days"], "values": [-1440]} – jede Zahl gibt die Anzahl der Minuten vor dem Fälligkeitsdatum an.Nein.Das Template – oder gar nichts.
instant_notifyfalse Es werden keine Anfragen bei der Veröffentlichung gesendet – nur die Erinnerungen werden übermittelt.Nein.Das Template oder true
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

Es beantwortet die Frage. 201 Mit dem… sign_id. Das Dokument des Templates wird im Hintergrund kopiert. Lesen Sie das elektronische Dokument bis es keine weiteren Informationen mehr enthält. copying.

Um Ihren eigenen PDF-Datei zu senden, erstellen Sie einfach die elektronische Signatur ohne template. Laden Sie anschließend die PDF-Datei hoch und warten Sie, bis sie fertig ist. Danach können Sie die Felder der Datei zuweisen. Weitere Informationen finden Sie in Uploaden und Anhänge mit einem Hub-Schlüssel hinzufügen.

Auswahl der Unterzeichner

Aus dem Vorlage-Format geht hervor, dass jeder Feldwert an die Personen im Fall weitergeleitet wird, die in der jeweiligen Rolle sind, wenn das elektronische Signieren stattfindet. Also sollten Sie zuerst den Kunden im Fall berücksichtigen. Die field_participants-Angaben zeigen dabei den Namen jedes Feldes sowie die Benutzeridentitäten der Personen, die das elektronische Signieren durchführen.

Um dies zu ändern, senden Sie die gesamte Karte an PUT /signs/<sign_id>/schema.

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • Jeder Identifikationsnachweis muss von jemandem stammen, der an dem Fall beteiligt ist. Die virtuelle Assistentin kann keine Unterschriften legen.
  • Die Feldnamen sind jene Bezeichnungen in dem Dokument.
  • Die neue Karte ersetzt die alte Karte: Das Feld, das ausgelassen wird, hat keine Signatur.

Veröffentlichung

PUT /signs/<sign_id>/publish nimmt keinen Wert an und gibt stattdessen 200 zurück. Mindestens ein Feld muss einen Signator haben; ein Feld ohne Signator bleibt leer.

  • Jeder Unterschreiber erhält sofort eine E-Mail mit der Aufforderung zur Unterschrift. Falls er keine E-Mail-Adresse hat, wird ihm eine Nachricht per SMS gesendet. instant_notify ist false. Es erscheint auf ihren… Was zu tun ist:Machen Die Liste auf einem Koffer mit Dingen, die auf Sie warten, wie zum Beispiel auszufüllende Formulare, zu unterschreibende Dokumente oder zu bestätigende Termine. Und auch in den Benachrichtigungen auf ihrem Portal.
  • Die Erinnerungen werden jedes Mal in der Zeit von notifications verschickt – bis sie unterschrieben wurden.
  • Jemand, der aus dem Fall herausgekommen ist, hält den Gegenstand jetzt in den Händen.

Nach den Unterschriften

Die elektronischen Signatur status liest completed Sobald alle Unterschriften eingereicht wurden… completed_on Es wird angegeben, zu welcher Zeit in UTC dies der Fall ist. 2026-10-06T21:42:10.123456+00:00. Bis dahin hat es noch nichts davon gegeben. responses Jeder Unterzeichner, der unterschrieben hat, wird mit einer entsprechenden Karte versehen. response_id.

GET /signs/<sign_id>/responses Die Liste enthält die Unterschriften aller Unterzeichner. Die ältesten Unterschriften stehen zuerst. Alles ist auf einer einzigen Seite dargestellt. Jede Unterschrift wird dabei separat angezeigt. user_id, Als sie unterschrieben haben, sind die Felder, auf die sie ihre Daten eingaben, bereits gefüllt. response.formFieldValues, Ihre Unterschrift unterschreiben. response.annotations, Mit einer beliebigen Signaturbildunterlage. response.attachments, Und die IP-Adresse, von der sie ihre Signatur erhielten. response.ip.

Dem Personal, das mit dem Fall zu tun hat, wird jedes Mal mitgeteilt, wenn jemand unterschreibt – und auch wieder, wenn die unterschriebenen Unterlagen fertig sind. Dabei wird auch jedem Personen, der unterschreibt, mitgeteilt, wann die unterschriebenen Unterlagen fertig sind.

Die gesperrte Kopie

Sobald alle Unterschriften vorliegen, wird eine gesicherte Kopie erstellt – mit jeder einzelnen Unterschrift. Die Eintragung des Dokuments unter media.schemas.items erhält die Werte flat, der Pfad der Kopie sowie flat_status, SUCCEEDED oder FAILED. Sie können das Dokument als beliebiges Dateiformat herunterladen. Weitere Informationen finden Sie in Upload und anhängen von Dateien mit einem Hub-Key.

Auflistung und Löschung

GET /signs benötigt filter: all listet alle elektronischen Signatur auf der Liste auf – einschließlich der noch nicht veröffentlichten Signaturen. Die neuesten Signaturen werden zuerst aufgeführt. self listet die von dem virtuellen Assistenten gesendeten Signaturen auf – entweder über die Schlüssel oder durch automatische Prozesse. completed und uncompleted listen die Signatur des Anrufers auf. Bei einem Schlüssel sind diese Felder also immer leer. Überprüfen Sie stattdessen die status- und completed_on-Felder jeder einzelnen elektronischen Signatur.

DELETE /signs/<sign_id> löscht jederzeit die elektronischen Signatur sowie alle damit verbundenen Informationen und setzt diese außer Kraft. Niemand wird darüber informiert.

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptionEs fehlt ein Feld oder es ist das Feld ungültig – beispielsweise gibt es eine Komma in name, eine wiederholte Regel oder ein Signator, der nicht auf dem Fall steht. errors beschreibt dieses Feld.
400SchemaFieldsException, wobei ItemCopyNotAllowedException bei template liegt.Das Template ist nicht veröffentlicht, steht der Rolle der Bots nicht offen – oder seine Dateien werden noch bearbeitet.
403PublishAlreadyPublishedExceptionEs ist bereits veröffentlicht worden – daher kann es nicht mehr geändert werden.
403PublishAlreadyAnsweredExceptionJemand hat es bereits unterschrieben.
403PublishParticipantsMissingExceptionKein Feld hat einen Signataren.
403PublishMediaMissingExceptionEs gibt bisher noch keine entsprechenden Dokumente.
403PublishMediaNotReadyExceptionSein Dokument wird immer noch kopiert oder konvertiert.
403PublishMediaFailedExceptionSein Dokument konnte nicht konvertiert werden.
403PublishDocumentUnreadableExceptionDieses Dokument kann nicht gelesen werden. Löschen Sie das elektronische Signaturverfahren und erstellen Sie das Dokument erneut.
403PublishDueTimePassedExceptionDie Fälligkeitstermin ist bereits verstrichen.
403BotNotAllowedExceptionEine Person versuchte, das Dokument zu unterschreiben – oder die Unterschrift von jemand anderem zu entfernen.
403CaseClosedExceptionDer Fall ist abgeschlossen.
404ItemNotFoundExceptionDie elektronische Unterschrift oder Signatur existiert nicht.

Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.

Verwandte Artikel

Verstehen Sie, was die API leisten kann.Erfahren Sie, welche Funktionen eine Verwaltungstaste und eine Hub-Taste jeweils haben, warum jede Taste als virtueller Assistent fungiert und wo Sie die vollständige technische Auflistung finden.IntegrationenFormulare senden und Antworten mit einem Hub-Schlüssel lesenErstellen Sie anhand einer Vorlage ein Formular zu einem Fall, veröffentlichen Sie es bei den Personen, die es ausfüllen sollen, und lesen Sie deren Antworten.IntegrationenDateien mit einem Hub-Schlüssel hochladen und anhängenEine Upload-Adresse abrufen, eine Datei hochladen, diese an einen Beitrag, eine Notiz, eine Aufgabe, ein Formular oder eine elektronische Signatur anhängen und die Akten eines Falls herunterladen.IntegrationenAPI-Fehler und Statuscodes behandelnLesen Sie den Fehlertext, was 400, 401, 403, 404, 500 und 503 bedeuten und warum ein Element, dessen Schlüssel nicht angezeigt werden kann, 404.Integrationen