Create an Envelope Sender View

POST /esignglobal/v1/envelopes/views/sender

Interface Description

This API allows developers to generate a sender view based on the envelope ID, enabling integration of the sender’s launch interface into third-party applications.

Notes:

The signing process initiated via the sender view is prefilled with user information obtained from the Access Token through OAuth authentication.
Before calling this API, you must first create an envelope in draft status using the Create Envelope API.
Once the envelope ID is obtained, you can configure the envelope by adding documents, signers, and other required details through corresponding APIs.
The sender view page generated by this API supports embedding in both iframe and webview environments. The default display language is English.
This API does not support workflows that include auto sign by signers.

Request Parameters

Parameter		Type	Required	Description
envelopeId		string	true	The Envelope ID. Only the signing process ID of 0-Draftis allowed.
returnUrl		string	true	The redirection address (length 2048) after sending the envelope, which must conform to the https /http protocol address.
settings		object	false	Sender View Page Customization Settings
	startingPage	string	false	Sender View Starting Page, Default: Prepare Page Prepare Page – Basic Information Setup Page Tagging Page – Signing Fields Setup Page
	submitAction	string	false	Submit Action, Default: send save-Save. Displays the "Save" button while hiding all Send-related buttons send-Send. Displays "Send Now", "Send", and "Send Later" buttons while hiding the Save button.
	showBackButton	boolean	false	Display Back Button on Tagging Page, default: true true: Show Back button false: Hide Back button

Request Example

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

Responses

Parameter	Type	Description
url	string	Envelope sending page url

Response Example

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}