Utiliser un modèle d'enveloppe pour lancer la signature

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

Description de l'interface

Initier la signature à l'aide du « modèle d'enveloppe » préconfiguré côté interface.

Paramètres de requête

Nom du paramètre				Type	Obligatoire	Description
envelopeTemplateId				string	true	ID du modèle d'enveloppe
envelopeConfig				object	true	Configuration du processus de signature
	contractConfig			boolean	false	Configuration de la signature du contrat
		envelopeRemark		array	false	Notes du contrat
	envelopeSubject			string	true	Sujet du processus de signature actuel
	expireAfterSeconds			int	false	Date limite de signature pour ce processus, après laquelle toute signature est impossible. Timestamp Unix en millisecondes, durée de validité par défaut et maximale de 90 jours.
	callbackUrl			string	false	Adresse Web pour recevoir les notifications de rappel
	redirectUrl			string	false	Doit être une adresse HTTPS valide
	signConfig			object	false	Configuration de signature
		allowTransfer		boolean	false	Autoriser le signataire à transférer cette enveloppe à d'autres personnes pour signature, par défaut false true-Autoriser le signataire de l'enveloppe à transférer celle-ci à d'autres personnes ; false-Ne pas autoriser le signataire de l'enveloppe à transférer celle-ci à d'autres personnes ;
participants				array	false	Configuration des participants
	participantId			string	true	ID de la partie participante
	authConfig			object	false	Configuration de l'authentification
		willingnessAuthModes		array	false	Mode de vérification de l'intention du signataire, par défaut noAuth noAuth-Aucune vérification accessCode-Vérification par mot de passe de signature sms-Vérification OTP par SMS idVerification-Vérification de pièce d'identité emailAuth-Vérification OTP par e-mail digitalId-Vérification d'identité électronique whatsappAuth-Vérification OTP WhatsApp
		accessCode		object	false	Paramètres du mot de passe de signature, obligatoire lorsque authModes=accessCode
			accessCode	string	false	Contenu du mot de passe, insensible à la casse, pouvant contenir des lettres et des chiffres, longueur maximale de 45
			promptInfo	string	false	Message d'invite du mot de passe d'accès, ne doit pas contenir le mot de passe d'accès, longueur maximale de 30, obligatoire lorsque authModes=1.
		sms		object	false	Vérification OTP par SMS, obligatoire lorsque authModes=sms
			countryCode	string	false	Indicatif international du pays ou de la région, sans transmettre le signe « + »
			number	string	false	Aucune vérification de format, seule une limite de longueur maximale de 13 caractères est appliquée
		idVerification		object	false	Paramètres de vérification de pièce d'identité, obligatoire lorsque authModes=idVerification
			name	string	false	Nom complet figurant sur la pièce d'identité du signataire, longueur maximale de 100 caractères
		emailAuth		object	false	Vérification OTP par e-mail, obligatoire lorsque authModes=emailAuth
			authEmail	string	false	Adresse e-mail de vérification d'identité du signataire
		digitalId		array	false	Vérification d'identité électronique, obligatoire lorsque authModes=digitalId
			authApp	string	false	Application utilisée pour la vérification d'identité électronique singpass - Authentification via Singpass iamsmart - Authentification via iAM Smart
			idNumber	string	false	Numéro de pièce d'identité du signataire à vérifier
		whatsappAuth		object	false	Vérification OTP WhatsApp, obligatoire lorsque authModes=whatsappAuth
			countryCode	string	false	Code international du pays ou de la région, sans le signe « + »
			number	string	false	Aucune vérification de format, longueur maximale limitée à 13 caractères
	participantInfos			object	false	Particulier
		userEmail		string	false	Adresse e-mail du signataire
		phoneNumber		object	false	Numéro de téléphone, vide par défaut Paramètre obligatoire pour les notifications par SMS, countryCode et number doivent tous deux être fournis
			countryCode	string	false	Code international du pays ou de la région, sans le signe « + »
			number	string	false	Aucune vérification de format, longueur maximale limitée à 13 caractères
		userName		string	false	Nom du particulier
		deliveryMethod		string	false	Mode de notification none - Aucune notification par message email - Notification par e-mail sms - Notification par SMS WhatsApp - Notification WhatsApp
		customizeSettings		object	false	Configuration personnalisée
			customizeMessage	object	false	Configuration personnalisée des notifications
			notificationLanguage	string	false	Langue de notification, anglais par défaut en-US Anglais zh-CN Chinois simplifié zh-Hant Chinois traditionnel ja Japonais ES-MX Espagnol
copiers				array	false	Ajouter un destinataire en copie
	copierId			string	true	ID du participant
	CCInfos			object	false	Informations du destinataire en copie
		userEmail		string	false	Adresse e-mail
		userName		string	false	Nom et prénom
		customizeSettings		object	false	Configuration personnalisée
			customizeMessage	object	false	Configuration personnalisée des notifications
			notificationLanguage	string	false	Langue de notification, anglais par défaut en-US Anglais zh-CN Chinois simplifié zh-Hant Chinois traditionnel ja Japonais ES-MX Espagnol
attchments				array	false	Informations sur l'ajout de pièce jointe (fichier ne nécessitant pas de signature)
	documentId			string	false	ID du fichier de pièce jointe
	fileName			string	false	Nom du fichier de pièce jointe
components				array	false	Liste des contrôles
	documentId			string	false	ID du fichier auquel appartient le contrôle
	componentId			string	false	ID du contrôle
	componentKey			string	false	Clé du contrôle, (choisir soit l'ID du contrôle, soit la clé du contrôle)
	componentValue			string	false	Valeur de remplissage du contrôle
	editComponentValue			boolean	false	Détermine si le signataire peut modifier le contenu pré-rempli de ce contrôle, true par défaut true-Les signataires peuvent modifier les valeurs préremplies false-Les champs contenant des valeurs préremplies sont verrouillés en lecture seule et ne peuvent pas être modifiés par les signataires

Exemple de requête

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

Paramètres de réponse

Nom du paramètre	Type	Description
envelopeId	string	ID de l'enveloppe

Exemple de réponse

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}