Documentation - Détails signature

Général

Le paramètre query string details peut-être utilisé avec plusieurs API pour modifier la quantité d'informations retournées pour chaque representation JSON de l'objet Signature. Ce paramètre contient une liste de mots-clé séparés par des virgules, permettant de retourner une famille d'informations associées aux objets Signature :

• data
  Retourne la valeur opaque clientData transmise par le client.
• attributes
  Retourne l'objet de propriétés nommées attributes.
• documents
  Retourne le tableau d'objets representant les documents PDF à signer.
• positions
  Retourne le tableau d'objets position des documents PDF à signer.
• links
  Retourne les liens pour la page publique de signature, les liens public des fichiers PDF et SVG des documents, et le lien représentant la ressource API de la Signature.
• all
  Retourne toutes les informations précédentes.

Valeurs du JSON retourné

• cancelled
  1
  
  État abandonné de la Signature. Permet de désactiver une demande de signature sans invalider le lien envoyé au signataire.
• description
  1
  
  Description globale des documents à signer.
• token
  1
  
  Identifiant unique de l'objet Signature.
• creationDate
  1
  
  Chaîne au format ISO8601 de la date de création de l'objet Signature.
• expirationDate
  1
  
  Chaîne au format ISO8601 de la date d'expiration de la signature, ou null si elle n'expire jamais.
• allowedMethods
  1
  
  Chaîne contenant la liste des méthodes de signature proposées au signataire, séparées par des virgules.
• signatureDate
  0..1
  
  Chaîne au format ISO8601 de la date de signature du ou des documents, présente uniquement si le ou les documents ont été signés.
• signatureMethod
  0..1
  
  Chaîne contenant la méthode utilisée pour signer le ou les documents, présente uniquement si le ou les documents ont été signés.
• signatoryName
  1
  
  Chaîne contenant le nom du signataire.
• signatoryCompany
  1
  
  Chaîne contenant le nom de la société ou l'organisation à laquelle appartient le signataire, ou null.
• signatoryEmail
  1
  
  Chaîne contenant l'adresse E-mail du signataire, ou null.
• signatoryMobile
  1
  
  Chaîne contenant le numéro internationnal de téléphone portable du signataire, ou null.
• clientData
  1
  data
  
  Valeur opaque de n'importe quel type associée au client.
• notificationUrl
  1
  1
  
  Chaîne contenant la liste des URLs de notification, séparées par des virgules, ou null.
• redirectionUrl
  1
  1
  
  Chaîne contenant l'URLs de redirection du signataire après avoir signé, ou null.
• attributes
  1
  attributes
  
  Objet de propriétés nommées.
• documents
  1..n
  documents
  
  Tableau d'objets document représentant le ou les documents PDFs à signer.
  • number
    1
    documents
    
    Entier correspondant un numéro du document.
  • description
    1
    documents
    
    Chaîne contenant la description spécifique du document, ou null.
  • fileName
    1
    documents
    
    Chaîne contenant le nom de fichier du document, ou null.
  • positions
    0..n
    documents
    +
    positions
    
    Tableau d'objets position, potentiellement vide, spécifiant où sera apposée la signature.
    • page
      1
      documents
      +
      positions
      
      Entier représentant le numéro de la page où la signature sera apposée, ou la chaîne new ou all.
    • offsetX
      1
      documents
      +
      positions
      
      Entier représentant la position horizontale en millimètres, en partant de la gauche où sera apposé la signature.
    • offsetY
      1
      documents
      +
      positions
      
      Entier représentant la position verticale en millimètres, en partant du haut où sera apposé la signature.
    • sizeX
      1
      documents
      +
      positions
      
      Entier représentant la taille horizontale maximale en millimètres de l'image de signature.
    • sizeY
      1
      documents
      +
      positions
      
      Entier représentant la taille horizontale maximale en millimètres de l'image de signature.
    • orientation
      1
      documents
      +
      positions
      
      Chaîne représentant l'orientation de l'image de signature.
  • pdfUrl
    1
    documents
    +
    links
    
    Chaîne contenant l'URL du fichier PDF du document.
  • svgUrl
    1
    documents
    +
    links
    
    Chaîne contenant l'URL du fichier image du document.
• resourceUrl
  1
  links
  
  Chaîne contenant l'URL de la ressource API de l'objet Signature.
• signUrl
  1
  links
  
  Chaîne contenant l'URL de signature à transmettre au signataire.

JSON retourné avec tous les détails

{
	"success": true,
	"signature": {
		"cancelled": false,
		"description": "Contrat à signer",
		"token": "rKQ9qljTcXdynOzxBCnzfi3cWuqNDQl0",
		"creationDate": "2024-12-24T02:37:58+01:00",
		"allowedMethods": "email,touch",
		"signatoryName": "Pascal Dupont",
		"signatoryEmail": "pascal.dupont@laposte.fr",
		"signatoryMobile": "+336123456789",
		"notificationUrl": "https://erp.client.org/sigtool/document-signed,mailto:notification@client.org",
		"redirectionUrl": null,
		"attributes": {
			"signatory.must-agree": {
				"fr": "Veuillez lire et accepter les termes du contrat"
			}
		},
		"documents": [
			{
				"number": 1,
				"description": "Contrat à signer",
				"fileName": "Contrat à signer.pdf",
				"positions": [
					{
						"page": 1,
						"offsetX": 15,
						"offsetY": 240,
						"sizeX": 70,
						"sizeY": 35,
						"orientation": "right"
					}
				],
				"pdfUrl": "https://https://www.sigtool.com/api/signatures/rKQ9qljTcXdynOzxBCnzfi3cWuqNDQl0/pdf/1",
				"svgUrl": "https://https://www.sigtool.com/api/signatures/rKQ9qljTcXdynOzxBCnzfi3cWuqNDQl0/image/1"
			}
		],
		"resourceUrl": "https://www.sigtool.com/api/signatures/rKQ9qljTcXdynOzxBCnzfi3cWuqNDQl0",
		"signUrl": "https://www.sigtool.com/sign/identifiantclient/rKQ9qljTcXdynOzxBCnzfi3cWuqNDQl0"
	}
}