Get Details of Signer Template Control

GET/esignglobal/v1/templates/signerFieldsDetail

Interface Description

Query the signer control information in the template.

Use the contract template IDtemplateIdto retrieve the signer control settings in the template. You can then usethe API to quickly initiate an envelope.

Request Parameters

Parameter Name	Type	Required	Description
templateId	string	true	Contract Template ID, which can be queried in the SaaS template management

Request Example

GET  https:// … …/esignglobal/v1/templates/signerFieldsDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

Response Parameters

Parameter Name				Type	Description
templateId				string	Contract Template ID
templateName				string	Contract Template Name
documentFields				array	File Control List
	fieldType			string	List of file dimension controls. Used to add file dimension controls that are not bound to signers on specified files.
	pageNo			string	Control type. Pass eMeterai to indicate the Indonesian stamp duty control.
	posX			float	Page number where the control is located. The Indonesian stamp duty control only supports specifying a single page; you must pass a single page number. Continuous or non-continuous multi-page formats such as 1-3 or 1,3 are not supported.
	posY			float	X-axis offset, with the bottom-left corner of the page as the origin. The coordinate range is consistent with other controls' coordinate ranges.
signerFields				array	List information of signer controls in the template
	signConfigs			array	Signer control information
		fieldId		string	Control ID (automatically generated by the system when setting up the contract template)eSignGlobal
		fieldKey		string	Control Key (custom-defined by the user when setting up the contract template)
		fieldType		string	Control type: signature- Signature Area stamp- Seal Area approval- Approval Control
		required		boolean	Whether it is required, default is required true- Required false- Not Required
		sizeRule		string	Display Method for Signing Area Dimensions originalSize- Place seal based on actual signature/seal dimensions targetSize- Customize width and height of signature/seal area
		height		int	Signing Control Height
		width		int	Signing Control Width
		movable		boolean	Allow repositioning during signing false- Signer cannot adjust the position of their own signing control true- Signer can adjust the position of their own signing control
		allowedOptions		array	Options allowing the signer to approve, applicable when fieldType is 'approval'. Default is ["approve", "decline"] approve- Agree decline- Reject
		posX		float	Control position X coordinate
		posY		float	Control positionYY coordinate
		pageNo		string	Page number where the control is located
	fillConfigs			array	Signature control information
		fieldId		string	Control ID (automatically generated by the system when setting up the contract template)eSignGlobal
		fieldKey		string	Control Key (customized by the user when setting up the contract template)
		fieldName		string	Control name
		required		boolean	Required field true- Required false- Optional
		fieldsType		string	Control type: 1- Single-line text 15- Checkbox
		textField		object	Text control properties
			overflowType	int	Only applies to text 1- Auto-shrink font size 2- Limit input
			minFontSize	float	Only applies to text, and only when overflowType=1. 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			width	float	Control width
			fontSize	float	Only applies to text, font size 5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72
			textColor	string	Only applies to text, hexadecimal color
			bold	boolean	Only applies to text, whether the font is bold true- Bold false- Not bold
			italic	boolean	Only applies to text, whether italic true- Italic false-Not italic
			underline	boolean	Applies only to text; whether to add underline true-Add underline false-Do not add underline
			lineThrough	boolean	Applies only to text; whether to add strikethrough true-Add strikethrough false-Do not add strikethrough
			horizontalAlignment	string	Applies only to text; horizontal center alignment format LEFT-Align left CENTER-Center RIGHT-Align right
		tickBoxField		object	Checkbox properties
			tickOptions	array	Applies only to Check 1-Check mark 2-Cross mark
		posX		float	Control position X coordinate
		posY		float	Control positionYY coordinate
		pageNo		string	Page number where the control is located
	signDateConfigs			array	Signature date information
		fieldId		string	Control ID (automatically generated by the system when setting up the contract template)eSignGlobal
		fieldKey		string	Control Key (user-defined when setting up the contract template)
		movable		boolean	Allow moving position during signing false- Signers are not allowed to adjust their own signature control positions true- Signers are allowed to adjust their own signature control positions
		posX		float	Control position X coordinate
		posY		float	Control positionYY coordinate
		pageNo		string	Page number where the control is located
		signDateFormat		string	Signature Date Format

Response Example

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"
}