This document is intended to provide an overview of the Scope (permission domain) within the eSign.AI application authorization system for ecosystem partner developers. When integrating with the application authorization system, developers must request the corresponding Scopes based on their actual business requirements. Each Scope includes a list of OpenAPIs permitted for invocation under that permission domain. The platform will strictly enforce the application's operational permissions on related resources according to the authorized Scopes.
Basic Authentication APIs
Before ecosystem applications officially invoke the APIs, they must first obtain call credentials via the authorization endpoint:
API Name
API Path
API Description
Obtain Access Token
POST /esignglobal/v1/oauth2/accessToken
Via appid and appsecret to obtain the authentication access_token, which is used to request the eSign.AI API as a specific user. The token is valid for 24 hours.
Currently, the Scope permission domains open to the eSign.AI ecosystem mainly include:
This Scope is the most fundamental and commonly used permission domain, containing the core end-to-end APIs for electronic signature services. After authorizing this Scope, applications can manage and operate templates, signing documents (including attachments), participants, and the main envelope workflow.
Module 1: Template Service
API Name
API Description
Get Signer Template Control Details
Retrieve template control information and corresponding attribute configurations for a specified signer
Get Template Details
Retrieve complete information for a specific template, including fields and document structure details
Populate Template to Generate Document
Fill business data into a given template and automatically generate a PDF file
Query Template List
Query the list of available templates under the current account using pagination or specific filter criteria
Query File Generation Task Details
Query the final execution result of a template-generated file task via asynchronous task ID
Module 2: File Management
API Name
API Description
Upload File
Upload specified local files or business workflow files to the platform for subsequent signing
Get Coordinates Based on Keywords
Perform text search on uploaded documents and return coordinate information for matching keywords
Download File
Download specific completed signed documents, source files, or other business attachments
Add Signing File
Bind previously successfully uploaded files to a specific signing envelope or workflow
Delete Signing File
Remove incorrectly uploaded or temporarily unneeded signing files from the envelope workflow
Add Attachment
Add supplementary explanatory attachments to the envelope or signing workflow
Delete Attachment
Remove specified attachment documents from the envelope or signing workflow
Module 3: Participant Management
Interface Name
Interface Description
Add Signer
Add a signing participant required to execute signature actions in a specific envelope workflow
Delete Signer
Remove discontinued signers from a specific envelope workflow
Add CC Recipient
Add CC role, which only receives progress notifications and can view the final signed document
Delete CC Recipient
Remove a specific CC role
Module 4: Envelope Management
API Name
API Description
Quickly Initiate Envelope
If the integrating platform uses this API to create an envelope and completes the signing, the system will automatically handle the termination process, eliminating the need to manually call "End Envelope".
Create Envelope
Used to create an envelope in draft status, supporting configuration of parameters such as the signing subject and signer settings.
Send Envelope
After confirming that all signing documents and signers are correct, formally dispatch the signing task downstream.
End Envelope
Manually end the envelope. All signers must complete their signatures before the envelope is terminated. Once the process concludes, the resources can no longer be modified.
Get Signing URL
Retrieve the exclusive short link or directly loadable signing page URL for a designated signer.
Query Envelope Details
Retrieve the envelope's overall information, associated documents, participants, and current workflow status.
Revoke Envelope
Actively withdraw a signing envelope that has not been fully completed by the initiator.
Envelope Reminder
When the envelope is not yet fully signed, supports sending reminder notifications to signers who are currently required to sign but have not done so. The reminder interval is 30 minutes.
Get Preview Signing Page URL
After the envelope is opened, this API can be used to retrieve the preview signing page URL. It is primarily used within the integrated platform to allow non-envelope participants to view signing documents and progress.
Create Envelope Sender View
Create an envelope sender view via the envelope ID. For signing workflows initiated under this view, the initiator information will be populated with the user details resolved from the OAuth Access Token.
2.2 Scope: stamp (Seal Management Service)
This scope is specifically dedicated to management authorization for corporate seals or personal name seals. It is suitable for third-party ecosystems that only require maintenance of a unified corporate seal library (add, delete, update, and query seals) without directly intervening in the signing initiation process.
API Name
API Description
Query Seal List
Use an AppID with corresponding seal query permissions to retrieve the list of seal resource data.
Create Seal
Use an authorized AppID to create a seal by passing the Base64-encoded string of the uploaded image (supports PNG, size 18mm-100mm).
Edit Stamp
Modify information such as the name and image of an existing stamp
Delete Stamp
Completely remove specified stamp resources that are no longer associated with any business operations
This Scope is dedicated to the intelligent contract legal function domain. It allows ecosystem partner applications to flexibly invoke text and version comparison capabilities during their own contract review and legal assessment processes, enabling rapid control over differences before and after contract revisions.
API Name
API Description
Get Contract Comparison Result Page
Get the URL of the visualization page displaying comparison difference results
Query Contract Comparison Details
Retrieve the contract comparison result via the contract comparison business ID, including the number of differences (additions, deletions, modifications) and detailed comparison content (itemized positioning)
