Query Envelope Details

GET /esignglobal/v1/envelope/envelopeDetail

Interface Description

Query the detailed information of the envelope, including the signing progress, envelope status, etc.

Request Parameters

Parameter Name	Type	Required	Description
envelopeId	string	true	Envelope ID

Request Example

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

Response Parameters

Parameter Name				Type	Description
envelopeId				string	Envelope ID
envelopeStatus				int	Envelope Status 0-Created (Draft) 1-Signing 2-Completed 3-Expired 4-Rejected 5-Revoked
envelopeEndTime				timestamp	Envelope End Time
envelopeCreateTime				timestamp	Envelope Start Time
subject				string	Envelope Subject
remark				string	Envelope Remarks (Length 1000)
redirectUrl				string	Signing Completion Redirect Address (Length 500)
CCInfos				array	CC Recipient Information Collection
	userEmail			string	CC Recipient Email Address
	userName			string	CC Recipient Name
initiatorInfo				object	Sender Information Collection
	userName			string	Sender's name, defaults to the name of the creator to whom the open application APPID belongs
signFiles				array	Collection of signature file information
	fileKey			string	Signature file fileKey
attachments				array	Envelope attachment collection
	fileKey			string	Envelope fileKey
signerInfos				array	Signer information
	businessId			string	Developer-defined business number (length 500)
	userName			string	Signer name
	userEmail			string	Signer's email address
	phoneNumber			object	Signer's SMS receiving address
		countryCode		string	International code of the country/region
		number		string	Signer's mobile phone number for receiving signature messages
	signOrder			int	Signer's signing order, the minimum is 1.
	digitalSignature			boolean	Whether to enable digital signature, default is false true-enable, false-disable
	authConfig			object	Verification method
		accessCode		object	Access password
			accessCode	string	Access password
			promptInfo	string	Access password hint
		sms		object	SMS OTP verification
			countryCode	string	International code for country/region
			number	string	Authentication mobile number
		idVerification		object	Identity verification
			name	string	Full name on the signer's ID document
		emailAuth		object	Email OTP verification
			authEmail	string	Signer's identity verification email address
		digitalId		object	Electronic identity verification
			authApp	string	APP used for electronic identity verification
			idNumber	string	Signer's ID number to be verified
		whatsappAuth		object	WhatsApp OTP verification
			countryCode	string	International code of country/region
			number	string	Authentication phone number
	signerStatus			int	Signer status 0-Pending signature 1-Signing 2-Signed
	signDate			timestamp	Signing time
	declinedReason			string	Reason for rejection, displayed when envelopeStatus is rejected
canceledReason				string	Reason for revocation, displayed when envelopeStatus is revoked

Response example

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "authConfig": {
                    "accessCode": {
                        "accessCode": "1234567",
                        "promptInfo": "test"
                    }
                },
                "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"
}