Marquer un document comme signé

Marquer un document comme signé lorsqu'une signature physique ou hors bande a été obtenue. Vous pouvez marquer l'ensemble du document comme terminé, ou marquer un destinataire individuel comme terminé si d'autres sont encore en train de signer. Vous pouvez télécharger un PDF signé en même temps.

Prérequis

• Votre ID de document (encodé en base64) — si vous avez un UUID REST, préfixez-le par doc puis encodez le résultat en base64 (par exemple doc + <votre-uuid-de-document> → base64). Voir Comprendre les IDs Web et API pour plus de détails.

Option A : Marquer comme signé sans téléchargement de PDF

Appelez markAsComplete avec isUploaded: false. Le champ declarationText est requis — utilisez-le pour indiquer la raison pour laquelle le document est marqué comme terminé (par exemple « Confirmation verbale reçue », « Signature manuscrite obtenue »). Il peut être laissé vide, mais une valeur significative est utile à des fins d’audit.

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

Option B : Marquer comme signé avec téléchargement de PDF

Étape 1 : Obtenir une URL de téléchargement pré-signée

Appelez la upload query avec uploadType: MARKASCOMPLETE pour obtenir une URL S3 à durée limitée.

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

Réponse :

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

Étape 2 : Envoyer le fichier sur S3 avec PUT

Téléchargez le PDF signé directement à l'URL retournée en utilisant une requête HTTP PUT avec Content-Type: application/pdf. L’URL est temporaire — utilisez-la immédiatement. Voir Télécharger des fichiers pour plus de détails sur l’étape PUT.

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

Étape 3 : Marquer le document comme terminé

Appelez markAsComplete avec isUploaded: true. Le champ declarationText fonctionne comme dans l’Option A.

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

Marquer un seul destinataire comme signé

Utilisez markRecipientAsComplete lorsqu’une partie a signé hors bande mais pas les autres.

Si vous souhaitez télécharger un PDF signé pour le destinataire, obtenez d’abord une URL pré-signée en utilisant uploadType: MARKRECIPIENTASCOMPLETE :

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

Ensuite, effectuez un PUT du fichier à l’URL retournée — voir Télécharger des fichiers.

Champs clés :

• suppressNextRecipientNotification — mettez à true pour empêcher la notification immédiate du prochain destinataire dans l’ordre de signature.
• auditlogText — optionnel. Laissez vide si non nécessaire, mais une valeur significative est utile à des fins d’audit.

Puis appelez markRecipientAsComplete :

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

Archiver le document (optionnel)

Une fois marqué comme terminé, vous pouvez archiver le document afin de le retirer de la vue des documents actifs.

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

Définissez restore: true pour désarchiver.

Connexes

• S’authentifier
• markAsComplete
• markRecipientAsComplete
• upload query