Simulan ang pagpirma gamit ang template ng envelope

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

Deskripsyon ng Interface

Gumamit ng paunang na-configure na "template ng envelope" sa panig ng pahina upang simulan ang pagpirma.

Mga Parameter ng Request

Pangalan ng Parameter				Uri	Kinakailangan	Paglalarawan
envelopeTemplateId				string	true	ID ng Template ng Envelope
envelopeConfig				object	true	Konpigurasyon ng Proseso ng Pagpirma
	contractConfig			boolean	false	Konpigurasyon ng Pagpirma ng Kontrata
		envelopeRemark		array	false	Mga Tala sa Kontrata
	envelopeSubject			string	true	Paksa ng Proseso ng Pagpirmang Ito
	expireAfterSeconds			int	false	Deadline ng pagpirma para sa prosesong ito; hindi na magagawa ang pagpirma pagkatapos ng oras na ito. Unix timestamp sa millisecond, default at maximum na expiration ay 90 araw.
	callbackUrl			string	false	Web address para tumanggap ng mga abiso ng callback
	redirectUrl			string	false	Dapat maging wastong https address
	signConfig			object	false	Item ng Konfigurasyon para sa Pag-sign
		allowTransfer		boolean	false	Pinapayagan ba ang tagapag-sign na ipasa ang envelope na ito sa iba para mag-sign, default ay false true - Pinapayagan ang mga tagapag-sign sa envelope na may karapatan na ipasa ang envelope sa iba; false - Hindi pinapayagan ang mga tagapag-sign sa envelope na may karapatan na ipasa ang envelope sa iba;
participants				array	false	Konfigurasyon ng mga Partisipante
	participantId			string	true	ID ng Partisipante
	authConfig			object	false	Item ng Konfigurasyon para sa Pagpapatunay
		willingnessAuthModes		array	false	Opsyonal na paraan ng pagpapatunay para sa tagapag-sign, default ay noAuth noAuth - Walang pagpapatunay accessCode - Gamitin ang password ng pag-sign para sa pagpapatunay sms - Pagpapatunay ng SMS OTP idVerification - Pagpapatunay ng dokumentong pang-identidad emailAuth - Pagpapatunay ng OTP sa email digitalId - Pagpapatunay ng digital na identidad whatsappAuth - Pagpapatunay ng OTP sa WhatsApp
		accessCode		object	false	Pag-set up ng password sa pagpirmahan, kailangan kapag ang authModes=accessCode
			accessCode	string	false	Nilalaman ng password, hindi sensitive sa kapital o maliit na letra, maaaring maglaman ng mga titik at numero, limitasyon sa haba ay 45
			promptInfo	string	false	Paalala para sa access password, hindi dapat maglaman ng access password, limitasyon sa haba ay 30, kailangan kapag ang authModes=1.
		sms		object	false	Pagsusuri ng SMS OTP, kailangan kapag ang authModes=sms
			countryCode	string	false	International code ng bansa o rehiyon, hindi kailangang ipasok ang “+”
			number	string	false	Walang pagsusuri sa format, limitado lamang ang haba hanggang sa maximum na 13
		idVerification		object	false	Pag-set up ng pagpapatunay ng ID, kailangan kapag ang authModes=idVerification
			name	string	false	Buong pangalan sa ID ng nagpirmahan, maximum na haba ay 100 character
		emailAuth		object	false	Pagsusuri ng email OTP, kailangan kapag ang authModes=emailAuth
			authEmail	string	false	Email address para sa pagpapatunay ng identidad ng nagpirmahan
		digitalId		array	false	Digital na pagpapatunay ng identidad, kailangan kapag ang authModes=digitalId
			authApp	string	false	APP na ginagamit para sa digital na pagpapatunay ng identidad singpass-Gamit ang Singpass para sa pagpapatunay ng identidad iamsmart-Gamit ang SmartID para sa pagpapatunay ng identidad
			idNumber	string	false	Numero ng ID ng nagpirmahan na kailangang patunayan
		whatsappAuth		object	false	Pagpapatunay ng OTP sa WhatsApp, kinakailangan kapag ang authModes=whatsappAuth
			countryCode	string	false	Pandaigdigang code ng bansa o rehiyon, hindi kailangang magpasok ng “+”
			number	string	false	Walang pagpapatunay ng format, limitado lamang ang haba sa maximum na 13 karakter
	participantInfos			object	false	Indibidwal na kalahok
		userEmail		string	false	Email ng tagapirmâ
		phoneNumber		object	false	Numero ng telepono, default na walang laman Kinakailangang parameter kapag kailangan ng SMS na abiso, dapat ipasok ang countryCode at number
			countryCode	string	false	Pandaigdigang code ng bansa o rehiyon, hindi kailangang magpasok ng “+”
			number	string	false	Walang pagpapatunay ng format, limitado lamang ang haba sa maximum na 13 karakter
		userName		string	false	Pangalan ng indibidwal
		deliveryMethod		string	false	Paraan ng abiso none - huwag ipadala ang mensahe na abiso email - ipadala ang abiso sa pamamagitan ng email sms - ipadala ang SMS na abiso WhatsApp - ipadala ang abiso sa pamamagitan ng WhatsApp
		customizeSettings		object	false	Pasadyang Konpigurasyon
			customizeMessage	object	false	Pasadyang Konpigurasyon para sa mga Abiso
			notificationLanguage	string	false	Wika ng abiso, default na Ingles en-US Ingles zh-CN Simpladong Tsino zh-Hant Tradisyonal na Tsino ja Hapones ES-MX Espanyol
copiers				array	false	Magdagdag ng CC na tagatanggap
	copierId			string	true	ID ng Partisipante
	CCInfos			object	false	Impormasyon ng CC na tagatanggap
		userEmail		string	false	Email
		userName		string	false	Buong Pangalan
		customizeSettings		object	false	Pasadyang Konpigurasyon
			customizeMessage	object	false	Pasadyang Konpigurasyon para sa mga Abiso
			notificationLanguage	string	false	Wika ng abiso, default na Ingles en-US Ingles zh-CN Simplifikadong Tsino zh-Hant Tradisyonal na Tsino ja Hapones ES-MX Espanyol
attchments				array	false	Impormasyon sa pagdaragdag ng attachment (mga file na hindi nangangailangan ng lagda)
	documentId			string	false	ID ng attachment file
	fileName			string	false	Pangalan ng attachment file
components				array	false	Listahan ng mga kontrol
	documentId			string	false	ID ng file kung saan nakapaloob ang kontrol
	componentId			string	false	ID ng kontrol
	componentKey			string	false	Key ng kontrol, (piliin ang ID o key ng kontrol)
	componentValue			string	false	Halaga ng pagpuno ng kontrol
	editComponentValue			boolean	false	Nagkontrol kung ang signatory ng kontrol na ito ay maaaring baguhin ang pre-filled na nilalaman, default ay true true-Maaaring baguhin ng tagapirm ang nakapre-fill na halaga false-Kung may nakapre-fill na halaga, i-lock bilang read-only at hindi mababago ng tagapirm

Halimbawa ng Hiling

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

Mga Parameter ng Responso

Pangalan ng Parameter	Uri	Paglalarawan
envelopeId	string	ID ng Envelope

Halimbawa ng Responso

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