Call Method
All Tencent eSign Open APIs are called via HTTPS. All responses are in JSON format.
Basic Information
Environment Domains
Business APIs
| Environment | Domain | Description |
|---|---|---|
| Test | https://api.test.sign.tencent.com | For development and testing |
| Production (Singapore) | https://sgapi.tencent-esign.com | Region-based, currently Singapore |
Full request URL = Environment domain + API prefix + specific path, e.g.:
https://sgapi.tencent-esign.com/openapi/v1/envelopesFile Upload APIs
File upload APIs use a separate domain. All file management endpoints share the same request URL, differentiated by the X-TC-Action header. See File Management API docs.
| Environment | Domain | Description |
|---|---|---|
| Test | https://file.test.sign.tencent.com | For development and testing |
| Production | https://sgfile.tencent-esign.com | Production environment |
Full request URL, e.g.:
POST https://sgfile.tencent-esign.com/Request Method & Content Type
| Endpoint Type | Method | Request Content-Type |
|---|---|---|
| Business APIs (create envelope, query details, etc.) | POST | application/json |
| File upload APIs (upload file, multipart upload, etc.) | POST | multipart/form-data |
| OAuth token endpoints (issue/revoke token) | POST | application/x-www-form-urlencoded |
Business API parameters are passed in the JSON body. OAuth token endpoint parameters are passed as form fields. See Authentication for details.
Operator User
When an app is created, it is automatically associated with a system user ID. You can specify the execution identity via the X-Operator-User-Id header. If omitted, the system user ID is used by default.
Some endpoints (those involving envelope-level permission checks, such as create, void, remind, etc.) require a real user ID that is a member of the current Space. Whether it is required is documented on each endpoint page.
SpaceId
An app (AppId) can be installed in one or more Spaces. When obtaining a token, specify the target Space via the space_id parameter. The issued access_token is valid only for that Space, and all subsequent business API calls are executed within it — no need to pass SpaceId again.
Time Format
All time fields use RFC3339/ISO 8601 format with any timezone offset:
2024-01-15T10:30:00Z(UTC)2024-01-15T18:30:00+08:00(UTC+8)