sproof Fastlane: Einholen von Signaturen (API)

Hallo Entwickler:in,

wir freuen uns, Ihnen die Integration der Fastlane-Funktionalität von sproof sign vorzustellen.

Stellen Sie sich vor, Ihre Empfänger:innen könnten Dokumente auf ihren Mobilgeräten mit nur wenigen Klicks signieren, ohne sich durch einen komplizierten Prozess navigieren zu müssen. Genau das ermöglicht Fastlane. Dieses Feature wurde speziell für Anwendungsfälle entwickelt, die schnelle und nahtlose Signaturprozesse erfordern, insbesondere auf mobilen Endgeräten.

Fastlane bietet einen geführten, schrittweisen Ablauf, der die Effizienz und Benutzerfreundlichkeit für Ihre Empfänger massiv erhöht. Sie können den gesamten Signaturprozess dabei individuell anpassen und konfigurieren, indem Sie ein Fastlane-Profil erstellen.

Um Fastlane zu nutzen, muss diese Funktion in Ihrem User-Plan freigeschaltet sein.

Dieser Leitfaden führt Sie durch die Erstellung eines Fastlane-Profils, das Senden einer Signaturanfrage mit aktivierter Fastlane-Option via API und die anschließende Abfrage des Status dieser Anfrage.

Fastlane Profile Generator

Bisher war diese detaillierte Konfiguration eines Fastlane-Profils ausschließlich über die API möglich. Mit dem neuen Fastlane Profile Generator steht Ihnen diese Funktionalität nun auch direkt in der Benutzeroberfläche zur Verfügung.

Um das Nutzererlebnis bei der Fastlane optimal anzupassen, können die einzelnen Prozessschritte und Eigenschaften individuell konfiguriert werden. Dies betrifft beispielsweise die Anzeige der verschiedenen Screens wie "welcome", "document", "provider", "sign" oder "end".

Sie finden den Fastlane Profile Generator im Bereich der Entwicklertools. Diese sind standardmäßig für alle Planinhaber:innen freigeschaltet. Sollten weitere Plan-Mitglieder Zugriff auf diese Einstellungen benötigen, kann dies über das Rollenmanagement definiert werden.

Schritt 1: Fastlane-Profil erstellen:

Um die während des Signaturprozesses anzuzeigenden Screens (welcome, document, provider, sign, end) und auch weitere Eigenschaften individuell zu konfigurieren, um das Nutzererlebnis optimal an Ihre Anforderungen anzupassen, erstellen wir in diesem Schritt ein Fastlane Profil.

API-Call: POST https://sign.sproof.com/api/v1/fastlane?token={{token}}

Dokumentation: Fastlane Profiles

{
  "name": "Document Signing for HR",
  "screens": {
    "welcome": {
      "enabled": true,
      "title": "Welcome to Fastlane",
      "description": "This is a test.",
      "icon": true,
      "showDocumentBtn": true
    },
    "end": {
      "enabled": true,
      "title": "",
      "description": "",
      "icon": true,
      "helpText": true,
      "shareDocumentBtn": true,
      "showDownloadDocBtn": true
    }
  },
  "successEmail": {
    "subject": "SUBJECT",
    "title": "THIS IS THE CUSTOM TITLE",
    "text": "CUSTOM TEXT THAT IS ADDED IN THE FASTLANE",
    "sendEmail": true
  }
}

Die Antwort auf diesen Aufruf enthält die id des Fastlane-Profiles (in diesem Beispiel b1f15495-8b48-4317-b279-1afee0d96e6e), die wir im nächsten Schritt benötigen.

{
    "id": "b1f15495-8b48-4317-b279-1afee0d96e6e",
    "name": "Document Signing for HR",
    "createdAt": "2025-08-05T05:11:43.293Z",
  // ... weitere Profilinformationen
}

Schritt 2: Signaturanfrage mit Fastlane-Profil erstellen

Jetzt erstellen wir die eigentliche Signaturanfrage und nutzen die id des Profils aus Schritt 1, um das Fastlane-Profil zu verwenden. Um Empffänger:innen über die Fastlane einzuladen muss die useFastlane-Flag auf true gesetzt werden.

API-Call: POST https://sign.sproof.com/api/v1/documents/signature

Dokumentation: Signature Requests

{
  "token": "{{token}}",
  "inviteData": {
    "sender": {
      "email": "{{email}}",
      "firstName": "sproof",
      "lastName": "Sender"
    },
    "recipients": [
      {
        "email": "max.mustermann@sproof.com",
        "firstName": "Max",
        "lastName": "Mustermann"
      }
    ],
    "subject": "This is the subject of the email to the recipient/s",
    "message": "This is a custom message sent in the email"
  },
  "envelopeData": {
    "documentDataArray": [
      {
        "data": "{{pdf_im_base64_format}}",
        "fileName": "wichtiger_vertrag.pdf",
        "recipientDetails": {
          "max.mustermann@sproof.com": {
            "role": "signer",
            "signaturePositions": [
              {"page": 0, "x": 0.57489, "y": 0.8455, "width": 0.35, "height": 0.1}
            ]
          }
        }
      }
    ],
    "useFastlane": true,
    "fastlaneProfileId": "b1f15495-8b48-4317-b279-1afee0d96e6e"
  }
}

Ersetzen Sie {{token}} durch Ihren API-Token.
{{email}} ist die E-Mail-Adresse des Absenders (muss ein Mitglied vom selben Plan sein).
{{pdf_im_base64_format}} sollte das Base64-kodierte PDF-Dokument enthalten das Sie unterschreiben möchten.
subject: Hier können Sie den Betreff der E-Mail wählen, die an den/die Empfänger geschickt wird.
messages:Hier können Sie eine individuelle Nachricht für die Email angeben.
useFastlane: true um den/die Empfänger über die Fastlane einzuladen.
fastlaneProfileId: Fügen Sie hier die id Ihres in Schritt 1 erstellten Fastlane Profiles ein.

Die Antwort auf diesen Aufruf enthält unter anderem ein member Object (= sender) und einen members Array in dem der/die Eingeladene/n angeführt sind. Die memberId des senders (member.id), verwenden wir in Schritt 4 um den aktuellen Status der Signaturanfrage abzufragen.

Schritt 3: Der:Die Empfänger:in werden nun per E-Mail benachrichtigt

In unserem Beispiel bekommt Max Mustermann eine Einladung zur Signatur.

Und wird durch die von uns zuvor konfigurierten Screens durchgeführt um seine Signatur zu setzen.

Schritt 4: Abfrage des aktuellen Status der Signaturanfrage

Mit get request status können Sie den Fortschritt einer Signatur-Anforderung verfolgen. Dazu müssen Sie nur den Token und die MemberId des Absenders angeben, um eine eindeutige Zuordnung der Anfrage für das jeweilige Dokument sicherstellt. Der Endpunkt gibt ein JSON-Objekt zurück, das detaillierte Informationen über das Dokument und dessen Status enthält.

Endpunkt: GET https://sign.sproof.com/api/v1/documents/{{memberId}}?token={{token}}

Ersetzen Sie {{memberId}} durch die id des senders, die Sie in der Response von Schritt 2 unter member.id erhalten haben.
Ersetzen Sie {{token}} erneut durch Ihren API-Token.

Wir hoffen, dieses Beispiel hilft Ihnen beim Start Ihrer Integration!

Bei Fragen stehen wir Ihnen gerne zur Verfügung.