Initiate signing using an envelope template

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

API Description

Initiate signing using the pre-configured "envelope template" on the client side.

Request Parameters

Parameter Name				Type	Required	Description
envelopeTemplateId				string	true	Envelope Template ID
envelopeConfig				object	true	Signing Workflow Configuration
	contractConfig			boolean	false	Contract Signing Configuration
		envelopeRemark		array	false	Contract Remarks
	envelopeSubject			string	true	Subject of the current signing process
	expireAfterSeconds			int	false	Signing deadline for this process. No further signing will be allowed after this time. Unix timestamp in milliseconds. Default and maximum validity period is 90 days.
	callbackUrl			string	false	Web URL for receiving callback notifications
	redirectUrl			string	false	Must be a valid HTTPS address
	signConfig			object	false	Signer Configuration Item
		allowTransfer		boolean	false	Whether the signer is allowed to transfer this envelope to others for signing, default false true-Allows the signer in the envelope to have the authority to transfer the envelope to others; false-Does not allow the signer in the envelope to have the authority to transfer the envelope to others;
participants				array	false	Participant Configuration
	participantId			string	true	Participant ID
	authConfig			object	false	Authentication Configuration Item
		willingnessAuthModes		array	false	Optional authentication method for the signer, default noAuth noAuth-No authentication accessCode-Verify using signing passcode sms-SMS OTP verification idVerification-ID document verification emailAuth-Email OTP verification digitalId-Digital identity verification whatsappAuth-WhatsApp OTP verification
		accessCode		object	false	Signature password settings, required when authModes=accessCode
			accessCode	string	false	Password content, case-insensitive, may contain alphanumeric characters, max length 45
			promptInfo	string	false	Access password prompt message, must not contain the access password, max length 30, required when authModes=1.
		sms		object	false	SMS OTP verification, required when authModes=sms
			countryCode	string	false	International country/region code, '+' is not required
			number	string	false	No format validation, max length limited to 13 characters
		idVerification		object	false	ID document verification settings, required when authModes=idVerification
			name	string	false	Full name on the signer's ID document, max length 100 characters
		emailAuth		object	false	Email OTP verification, required when authModes=emailAuth
			authEmail	string	false	Signer's identity verification email address
		digitalId		array	false	Digital ID verification, required when authModes=digitalId
			authApp	string	false	App used for digital ID verification singpass-Identity authentication using Singpass iamsmart-Identity authentication using iAM Smart
			idNumber	string	false	Signer's ID document number pending verification
		whatsappAuth		object	false	whatsapp OTP verification, required when authModes=whatsappAuth
			countryCode	string	false	International dialing code for the country/region, do not include '+'
			number	string	false	No format validation, only limits maximum length to 13 digits
	participantInfos			object	false	Individual participant
		userEmail		string	false	Signer email
		phoneNumber		object	false	Phone number, defaults to empty Required parameter when SMS notification is needed, both countryCode and number must be passed
			countryCode	string	false	International dialing code for the country/region, do not include '+'
			number	string	false	No format validation, only limits maximum length to 13 digits
		userName		string	false	Individual name
		deliveryMethod		string	false	Notification method none-Do not send message notifications email-Send email notifications sms-Send SMS notifications WhatsApp-Send WhatsApp notifications
		customizeSettings		object	false	Custom Configuration
			customizeMessage	object	false	Notification Custom Configuration
			notificationLanguage	string	false	Notification language, defaults to English en-US English zh-CN Simplified Chinese zh-Hant Traditional Chinese ja Japanese ES-MX Spanish
copiers				array	false	Add CC Recipient
	copierId			string	true	Participant ID
	CCInfos			object	false	CC Recipient Information
		userEmail		string	false	Email
		userName		string	false	Personal Name
		customizeSettings		object	false	Custom Configuration
			customizeMessage	object	false	Notification Custom Configuration
			notificationLanguage	string	false	Notification language, defaults to English en-US English zh-CN Simplified Chinese zh-Hant Traditional Chinese ja Japanese ES-MX Spanish
attchments				array	false	Add attachment (unsigned document) information
	documentId			string	false	Attachment file ID
	fileName			string	false	Attachment file name
components				array	false	Field list
	documentId			string	false	Document ID containing the field
	componentId			string	false	Field ID
	componentKey			string	false	Field key, (choose either field ID or field key)
	componentValue			string	false	Field fill value
	editComponentValue			boolean	false	Specifies whether the signer can modify the pre-filled content for this field, defaults to true true-Signer can modify pre-filled values false-Locked as read-only when pre-filled values exist; signer cannot modify

Request Example

{
  "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"
    }
  ]
}

Response Parameters

Parameter Name	Type	Description
envelopeId	string	Envelope ID

Response Example

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