Ein Dokument als unterschrieben markieren

Markieren Sie ein Dokument als unterschrieben, wenn eine physische oder außervertragliche Unterschrift erhalten wurde. Sie können das gesamte Dokument als abgeschlossen markieren oder einen einzelnen Empfänger als abgeschlossen markieren, wenn andere noch unterschreiben. Sie können gleichzeitig ein unterschriebenes PDF hochladen.

Voraussetzungen

• Ihre Dokument-ID (base64-kodiert) — wenn Sie eine REST-UUID haben, versehen Sie diese mit dem Präfix doc und kodieren Sie das Ergebnis in base64 (z. B. doc + <your-document-uuid> → base64). Siehe Web-IDs und API-IDs verstehen für Details.

Option A: Ohne PDF-Upload als unterschrieben markieren

Rufen Sie markAsComplete mit isUploaded: false auf. Das Feld declarationText ist erforderlich — verwenden Sie es, um den Grund zu dokumentieren, warum das Dokument als abgeschlossen markiert wird (z. B. "Verbal confirmation received", "Wet signature obtained"). Es kann auch leer gelassen werden, aber ein sinnvoller Wert ist für Prüfungszwecke nützlich.

mutation MarkAsComplete {
  markAsComplete(input: {
    documentId: "<document-id>"
    declarationText: "Verbal confirmation received"
    isUploaded: false
  })
}

Option B: Mit PDF-Upload als unterschrieben markieren

Schritt 1: Erhalten Sie eine vorab signierte Upload-URL

Rufen Sie die upload Abfrage mit uploadType: MARKASCOMPLETE auf, um eine kurzlebige S3-URL zu erhalten.

query GetUploadUrl {
  upload(
    id: "<document-id>"
    uploadType: MARKASCOMPLETE
    extension: "pdf"
  ) {
    url
  }
}

Antwort:

{
  "data": {
    "upload": {
      "url": "https://lon-files-clearing.s3-accelerate.amazonaws.com/upload/..."
    }
  }
}

Schritt 2: Laden Sie die Datei zu S3 hoch (PUT)

Laden Sie das unterschriebene PDF direkt über eine HTTP-PUT-Anfrage mit Content-Type: application/pdf zur zurückgegebenen URL hoch. Die URL ist kurzlebig — verwenden Sie sie sofort. Siehe Dateien hochladen für weitere Details zum PUT-Schritt.

curl -X PUT \
  -H "Content-Type: application/pdf" \
  --data-binary @signed-copy.pdf \
  "<url from previous step>"

Schritt 3: Markieren Sie das Dokument als abgeschlossen

Rufen Sie markAsComplete mit isUploaded: true auf. Das Feld declarationText verhält sich wie in Option A.

mutation MarkAsComplete {
  markAsComplete(input: {
    documentId: "<document-id>"
    declarationText: "Signed copy received by post"
    isUploaded: true
  })
}

Einen einzelnen Empfänger als unterschrieben markieren

Verwenden Sie markRecipientAsComplete, wenn eine Partei außervertraglich unterschrieben hat, andere jedoch nicht.

Wenn Sie ein unterschriebenes PDF für den Empfänger hochladen möchten, holen Sie sich zuerst eine vorab signierte URL mit uploadType: MARKRECIPIENTASCOMPLETE:

query GetUploadUrl {
  upload(
    id: "<recipient-id>"
    uploadType: MARKRECIPIENTASCOMPLETE
    extension: "pdf"
  ) {
    url
  }
}

Laden Sie dann die Datei zur zurückgegebenen URL hoch — siehe Dateien hochladen.

Wichtige Felder:

• suppressNextRecipientNotification — auf true setzen, um zu verhindern, dass der nächste Empfänger in der Signierreihenfolge sofort benachrichtigt wird.
• auditlogText — optional. Lassen Sie es leer, wenn nicht benötigt, aber ein sinnvoller Wert ist für Prüfungszwecke nützlich.

Rufen Sie danach markRecipientAsComplete auf:

mutation MarkRecipientAsComplete {
  markRecipientAsComplete(input: {
    recipientId: "<recipient-id>"
    documentOptions: NONE
    suppressNextRecipientNotification: false
    auditlogText: "Signed copy received by post"
  }) {
    id
    uploadId
  }
}

Archivieren des Dokuments (optional)

Sobald es als abgeschlossen markiert wurde, können Sie das Dokument archivieren, um es aus der Ansicht aktiver Dokumente zu entfernen.

mutation ArchiveDocument {
  archiveDocument(input: {
    documentId: "<document-id>"
    restore: false
  })
}

Setzen Sie restore: true, um die Archivierung rückgängig zu machen.

Verwandte Themen

• Authentifizieren
• markAsComplete
• markRecipientAsComplete
• upload Abfrage