View Envelope Template Details

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

API Description

Query the detailed attributes of a pre-configured "envelope template" on the frontend (including file structure, participant roles, and all preset control identifier Keys ).

Request Parameters

Parameter Name

Type

Required

Description

envelopeTemplateId

string

true

Envelope Template ID

queryComponents

boolean

false

Whether to query control information, default false

true-Yes

false-No

Request Example

 {
 	"envelopeTemplateId":"dc4be9641a3145bea97809018d7a9180",
 	"queryComponents":true
 }

Response Parameters

Parameter Name					Type	Description
code					int	Business code, 0 indicates success, non-zero indicates an error.
message					string	Business message Please determine the error status based on the code. Do not rely on message matching, as the message may be adjusted.
data					object	Business data
	envelopeTemplateId				string	Envelope template ID
	envelopeTemplateName				string	Workflow template name
	envelopeTemplateStatus				int	Workflow template available status 1-Enabled 0-Disabled
	digitalSignature				boolean	Enable digital signature true-Enabled false-Disabled
	signFiles				array	File information
		documentId			string	File ID
		fileName			string	File Name
	participants				array	Participant
		participantId			string	Participant ID
		participantSetMode			string	Participation Requirement (Method of Specifying Participants) presetSigner-Specified when using a template (designated by the template user) dedicateSigner-Fixed member (hardcoded into the template and cannot be changed) sender-Initiator
		participantInfos			object	Individual Participant
			userEmail		string	Signer Email
			phoneNumber		object	Phone number, defaults to empty Required parameter when SMS notification is needed; both countryCode and number must be provided
				countryCode	string	International country/region code, do not include '+'
				number	string	No format validation, maximum length is 13 characters
			userName		string	Individual Name
			deliveryMethod		string	Notification Method auto-Send email notification when userEmail is provided, send SMS notification when phoneNumber is provided none-Do not send message notifications email-Send email notification sms-Send SMS notification WhatsApp-Send WhatsApp notification
			customizeSettings		object	Custom configuration
				customizeMessage	string	Custom message Character limit: 1000
				notificationLanguage	string	Notification language, defaults to English en-US English zh-CN Simplified Chinese zh-Hant Traditional Chinese ja Japanese es-MX Spanish pt-PT Portuguese th-TH Thai id-ID Indonesian vi-VN Vietnamese ms-MY Malay fil-PH Filipino de-DE German fr-FR French ru-RU Russian it-IT Italian ko-KR Korean
		signOrder			int	Signing Order 1-255 Different participants can be repeated
		willingnessAuthModes			string	Optional signer intent methods, separated by English commas noAuth-No verification accessCode-Verify using signing password sms-SMS OTP Verification idVerification-ID Document Verification emailAuth-Email OTP Verification digitalId-Digital Identity Verification whatsappAuth-WhatsApp OTP Verification
			accessCode		object	Signing password setup, required when authModes=accessCode
				accessCode	string	Password content, case-insensitive, can contain alphanumeric characters, max length 45
				promptInfo	string	Access password prompt message, must not contain the access password, max length 30, required when authModes=1.
			sms		object	SMS OTP verification code, required when authModes=sms
				countryCode	string	Country/region international code, do not include "+"
				number	string	No format validation, only limited to a maximum length of 13 digits
			idVerification		object	ID document verification settings, required when authModes=idVerification
				name	string	Full name on the signer's ID document, max length 100 characters
			emailAuth		object	Email OTP verification code, required when authModes=emailAuth
				authEmail	string	Signer's identity verification email address
			digitalId		array	Electronic identity verification, required when authModes=digitalId
				authApp	string	APP used for electronic identity verification singpass-Identity authentication using Singpass iamsmart-Authentication using IAM Smart
				idNumber	string	Signatory's ID number to be verified
			whatsappAuth		object	WhatsApp OTP verification, required when authModes=whatsappAuth
				countryCode	string	International country/region code, no need to pass "+"
				number	string	No format validation, only limited to a maximum length of 13 characters
		components			object	Control information
	copiers				array	Set CC recipients
		copierId			string	Participant ID
		editable			boolean	Whether modification is allowed upon initiation
		CCInfos			object	CC recipient information
			userEmail		string	Email
			userName		string	Personal name
			customizeSettings		object	Custom Configuration
				notificationSettings	object	Notification Custom Configuration
				notificationLanguage	string	Notification language, defaults to English en-US English zh-CN Simplified Chinese zh-Hant Traditional Chinese ja Japanese ES-MX Spanish
	attachments				array	Attachment Information
		editable			boolean	Allow modification during initiation
		fileKey			string	Attachment filekey
		fileName			string	Attachment Name
		downloadUrl			string	Download link for the draft PDF file, valid for 60 minutes.
components					array	Control List
	documentId				string	File key of the control
	componentId				string	Control ID
	componentKey				string	Control Key (control identifier filled in by the user when setting up the document template)
	componentName				string	Control Name
	componentType				string	Control Type 1, Text 2, Number 3, Date 6, Standard Signature Area 8, Multi-line Text 9, Checkbox 10, Radio Button 11, Image 14, Dropdown Control 15, Check Box Control 20, Seal Area 21, Approval Area 22, Signing Date 23, Email 100, RMB
	componentDefaultValue				string	Control Default Value
	componentPosition				object	Control Position
		componentPositionX			float	Control Position X Coordinate
		componentPositionY			float	Control Position Y Coordinate
		componentPageNum			int	Control Page Number
	componentSize				object	Control Size
		componentWidth			int	Control Width (distance between left and right sides of the rectangle, in px)
		componentHeight			int	Control Height (distance between top and bottom sides of the rectangle, in px)
	componentTextFormat				object	Control Character Style
		font			int	Fill Font, default 1, 1-SimSun, 2-New SimSun, 4-SimHei, 5-KaiTi
		fontSize			float	Fill font size, default 12-Small 4 42-Chu Hao 36-Small Chu Hao 26-No. 1 24-Small No. 1 22-No. 2 19-Small No. 2 16-No. 3 15-Small No. 3 14-No. 4 12-Small No. 4 10.5-No. 5 9-Small No. 5
		textColor			string	Font color, default #000000 black
		bold			boolean	Bold, default false true-Yes false-No
		italic			boolean	Italic, default false true-Yes false-No
		horizontalAlignment			string	Horizontal alignment, default 1-left align LEFT-Left Align CENTER-Center Align RIGHT-Right Align
		verticalAlignment			string	Vertical alignment, default 1-top align (applies to multi-line text) TOP-Top Align MIDDLE-Center Align BOTTOM-Bottom Align
		textLineSpacing			float	Line spacing, default 1.0, supports up to one decimal place, maximum value is 2.0 (applies to multi-line text)
	required				boolean	Required true-Required false-Optional
	componentMaxLength				string	Maximum fillable length of the control (number of Chinese characters)
	componentSpecialAttribute				object	Control-specific properties
		numberFormat			string	Number format (Number control) Integer: 0 One decimal place: 0.0 Two decimal places: 0.00
		dateFormat			string	Date format (Date control)
		imageType			string	Image type (Image control) IDCard_widthwise ID Card Horizontal Lock Aspect Ratio IDCard_longitudinal ID Card Vertical Lock Aspect Ratio other Other No Lock Aspect Ratio
		options			array	Options (Dropdown control, Single-select control, Multi-select control)
			optionOrder		int	Option order
			optionContent		string	Option Content
			selected		boolean	Default Selected
			optionPositionX		float	X Coordinate of Child Element in Parent Control Bounds
			optionPositionY		float	Y Coordinate of Child Element in Parent Control Bounds
			optionWidth		float	Child Element Width
			optionHeight		float	Child Element Height
	signField				object	General Signing Area Properties
		fieldStyle			int32	Signing Area Style 1-Single Page Signing Area 2-Cross-page Signing Area
		sizeRule			int	Seal Specifications 1-Apply Seal Using Actual Specifications 2-Custom Specifications (Adapt to Signing Area Width and Height)
		movable			boolean	true-Movable During Signing false-Not Movable During Signing
	stampField				object	Seal Area Properties
		fieldStyle			int	Signing Area Style 1-Single Page Signing Area 2-Cross-page Signing Area
		sizeRule			int	Seal Specifications 1-Apply seal according to actual specifications 2-Custom specifications (adapted to signing area width and height)
		movable			boolean	true-Can be moved during signing false-Cannot be moved during signing
	signDateField				object	Signing Date Properties
		dateFormat			string	Date format: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Approval Area Properties
		allowedOptions			array	Options allowing the signer to approve, applicable when fieldType is approval. Defaults to ["approve", "decline"] approve-Approve decline-reject

Response Example

{
  "code": "0",
  "data": {
    "envelopeTemplateName": "test",
    "signFiles": [
      {
        "fileDownloadUrl": "https://******",
        "fileName": "***.pdf",
        "documentId": "$eac****-d6f8-4b6b-bafe-******$3328404894"
      }
    ],
    "attachments": [],
    "digitalSignature": false,
    "envelopeTemplateStatus": 1,
    "independentComponents": [],
    "envelopeCategoryId": null,
    "envelopeTemplateId": "dc4be9641a3145bea97809018d7a9180",
    "participants": [
      {
        "participantFlag": "",
        "idVerification": null,
        "components": [
          {
            "componentType": "10",
            "componentId": "556b60f7bd324428908b41f3bbec8c54",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 485.42538,
              "componentPositionX": 35.96627,
              "componentPageNum": "1"
            },
            "componentSpecialAttribute": {
              "options": [
                {
                  "optionContent": "***",
                  "optionHeight": 32.923893,
                  "optionOrder": 0,
                  "optionPositionY": 85.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项二",
                  "optionHeight": 15.0,
                  "optionOrder": 1,
                  "optionPositionY": 60.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项三",
                  "optionHeight": 15.0,
                  "optionOrder": 2,
                  "optionPositionY": 35.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项四",
                  "optionHeight": 15.0,
                  "optionOrder": 3,
                  "optionPositionY": 10.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                }
              ],
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 128,
              "componentWidth": 144
            },
            "signDateField": null,
            "required": true,
            "stampField": null,
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "单选1",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          },
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "****",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "42750b92c7a***05134dd5342",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "presetSigner",
        "emailAuth": null
      },
      {
        "participantFlag": "***",
        "idVerification": null,
        "components": [
          {
            "componentType": "20",
            "componentId": "7c401b43cdc94b61a7813aa58ac82bbf",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 327.15793,
              "componentPositionX": 109.17395,
              "componentPageNum": "2"
            },
            "componentSpecialAttribute": {
              "options": null,
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 150,
              "componentWidth": 150
            },
            "signDateField": null,
            "required": true,
            "stampField": {
              "movable": false,
              "sizeRule": 1,
              "fieldStyle": 1
            },
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "图章区",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          }
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "***",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "b055dfce00c5******40cdabb23822ea4",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "dedicateSigner",
        "emailAuth": null
      }
    ],
    "copiers": []
  },
  "message": "SUCCESS"
}