Add Signature Document

POST /esignglobal/v1/envelope/files/addSignFiles

Interface Description

When the envelope is not opened, you can add documents to be signed to the envelope. Envelopes that have already been opened do not support appending signing documents.

Request Parameters

Parameter Name			Type	Required	Description
envelopeId			string	true	Envelope ID
signFiles			array	true	Signing document information collection, displayed in the order of file addition.
	fileKey		string	true	Signing document fileKey, only supports PDF format
	documentFields		array	false	File-level control list. Used to add file-level controls that are not bound to signers on specified files.
		fieldType	string	false	Control type. Pass eMeterai to indicate the Indonesian stamp duty control.
		pageNo	string	false	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.
		posX	float	false	X-axis offset, with the bottom-left corner of the page as the coordinate origin. The coordinate range is consistent with other control coordinate ranges.
		posY	float	false	Y-axis offset, with the bottom-left corner of the page as the coordinate origin. The coordinate range is consistent with other control coordinate ranges.

Request Example

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

Response Parameters

Parameter Name	Type	Description
code	int	Business code, where 0 indicates success and non-zero indicates an exception.
message	string	Business Information [Note] Please determine the error status based on the code. Do not rely on matching the message, as the message may be adjusted.
data	object	Business Data

Response Example

{
    "code": "0",
    "message": "success",
    "data": null
}