Envelope Details

GET /esignglobal/v1/envelope/envelopeDetail

Interface Description

Query envelope details, including signing progress and envelope status.

Request Parameters

Parameter	Type	Required	Description
envelopeId	string	true	Envelope ID

Request Example

GET https://……/esignglobal/v1/envelope/envelopeDetail?envelopeId=flow1234567890

Responses

Parameter			Type	Description
envelopeId			string	Envelope ID
envelopeStatus			int	Envelope Status 0-Draft 1-In Progress 2-Completed 3-Expired 5-Canceled
envelopeEndTime			timestamp	Envelope End Time
envelopeCreateTime			timestamp	Envelope Start Time
subject			string	Name of the envelope
remark			string	Envelope message to all recipients
redirectUrl			string	The page signers will be redirected to after completing signing process.
CCInfos			array	CC recipient information
	userEmail		string	Email Address
	userName		string	Name
InitiatorInfo			object	Sendor Information
	userName		string	The name of the sender.
signFiles			array	The information of the documents that need to be signed.
	fileKey		string	Document fileKey
attachments			array	Envelope Attachment
	fileKey		string	Attachment fileKey
signerInfos			array	Signatory Information
	businessId		string	Developer customized business number.
	userName		string	Name of signatory
	userEmail		string	Email Address of Signer
	phoneNumber		object	Phone Number of Signer
		countryCode	string	The International Code of the country region.
		number	string	Phone Number
	signOrder		string	Signer's sign order.
	accessCode		string	Access code content.
	signerStatus		int	Status of the signer's signing: 0-To be signed 1-Signing 2-Signed
	signDate		timestamp	Time Signed
	canceledReason		string	Canceled reason, displayed when envelopeStatus is set to Canceled.

Response Example

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyantest2@tsign.cn",
                "userName": "muyantest2222",
                "signDate": null,
                "signOrder": "1"
            },
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyan@tsign.cn",
                "userName": "muyant",
                "signDate": null,
                "signOrder": "1"
            }
        ],
        "envelopeExpireTime": 1724055000193,
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "envelopeCreateTime": null,
        "redirectUrl": "https://www.baidu.com",
        "attachments": [

        ],
        "canceledReason": null,
        "subject": "api create envelope hxqibLJpBD",
        "envelopeEndTime": null,
        "remark": "api remark",
        "CCInfos": null,
        "initiatorInfo": {
            "userName": "muyantest2"
        },
        "expireTime": 1724055000193,
        "envelopeId": "4a97d269d48642bb8b9d4878cde843a3",
        "envelopeStatus": 0
    },
    "message": "success"
}