Get Envelope Detail
POST/openapi/v1/envelopes/detail
Get the envelope's current status and signer progress.
Request Parameters
Header Parameters
AuthorizationRequiredstring
Bearer <access_token>
X-Operator-User-IdOptionalstring
Operator user ID (optional; defaults to the system user ID if not provided)
Request Body
application/jsonEnvelopeIdRequiredstring
Envelope ID (required)
Request Example
{
"EnvelopeId": "SGEV1234567890"
}Response Parameters
Response.Data
EnvelopeIdOptionalstring
Envelope ID
OutEnvelopeIdOptionalstring
External business ID (returned if provided when creating, otherwise empty)
BasicInfoOptionalobject
Envelope basic info
EnvelopeTitleRequiredstring
Envelope title, max 100 characters (required)
SigningOrderTypeRequiredstring
Signing order type (required). parallel = all signers receive invitations at once; sequential = invitations are sent one by one according to Signers[].SigningOrder.
parallelsequential
EnvelopeDescriptionOptionalstring
Envelope description / remarks (optional)
ExpirationRequiredobject
Expiration settings (required)
ExpiresAtRequiredstring(date-time)
Signing deadline in RFC3339 format, e.g., 2024-02-15T23:59:59Z. The envelope is automatically voided after this time
EmailNotificationOptionalobject
Email notification settings (optional). When omitted, EmailSubject defaults to the envelope's EnvelopeTitle and EmailMessage is empty.
EmailSubjectOptionalstring
Signing invitation email subject (optional, defaults to envelope's EnvelopeTitle)
EmailMessageOptionalstring
Email body shown to recipients (optional)
StatusDetailOptionalobject
Envelope status detail
StatusOptionalstring
Envelope current status. draft; sent (including delivered/viewed/partial-signed); completed; voided; declined.
draftsentcompletedvoideddeclined
CreatedAtOptionalstring(date-time)
Creation time, RFC3339 format
SentAtOptionalstring(date-time)
Sent time, RFC3339 format (empty for draft)
CompletedAtOptionalstring(date-time)
Completion time, RFC3339 format (only when completed)
VoidedAtOptionalstring(date-time)
Voided time, RFC3339 format (only when voided)
VoidReasonOptionalstring
Void reason (only when voided)
DocumentsOptionalarray<object>
Document list
DocumentIdOptionalstring
System-assigned document ID
NameOptionalstring
Document name
OrderOptionalinteger
Document display order
PageCountOptionalinteger
Document page count
SignersOptionalarray<object>
Signer list with signing status
RecipientIdOptionalstring
System-assigned recipient ID
NameOptionalstring
Name (required)
EmailOptionalstring
Email (masked, e.g. z***@example.com)
SigningOrderOptionalinteger
Signing order (0 when SigningOrderType=parallel)
StatusOptionalstring
Signer status. created; sent; delivered; viewed; signed; declined; voided.
createdsentdeliveredviewedsigneddeclinedvoided
SignedAtOptionalstring(date-time)
Signing completion time, RFC3339 format (only when signed)
StatusUpdatedAtOptionalstring(date-time)
Last status update time, RFC3339 format
DeclineReasonOptionalstring
Decline reason (only when declined)
CarbonCopiesOptionalarray<object>
Carbon-copy recipient list
RecipientIdOptionalstring
System-assigned recipient ID
NameOptionalstring
Name (required)
EmailOptionalstring
Email (masked, e.g. z***@example.com)
StatusOptionalstring
Carbon-copy status. created; sent; delivered; viewed.
createdsentdeliveredviewed
StatusUpdatedAtOptionalstring(date-time)
Last status update time, RFC3339 format
TabsOptionalarray<object>
All signing tabs of the envelope
TabIdOptionalstring
System-assigned tab ID
TabTypeOptionalstring
Tab type
signHerestampinitialHeredateSignedtextcheckboxdate
RecipientIdOptionalstring
Owning signer ID
DocumentIdOptionalstring
Owning document ID
PositionOptionalobject
Tab position
PositionTypeRequiredstring
Positioning mode (required). `absolute` = absolute coordinates; `anchor` = keyword-based positioning.
absoluteanchor
PageNumberOptionalinteger
Page number (starts from 1). Required for `absolute` mode. Optional for `anchor` mode; omit or set to 0 to search the whole document.
XPositionOptionalnumber(double)
X coordinate, unit: pt. Required for `absolute` mode; must NOT be set for `anchor` mode.
YPositionOptionalnumber(double)
Y coordinate, unit: pt. Required for `absolute` mode; must NOT be set for `anchor` mode.
WidthOptionalnumber(double)
Width, unit: pt (optional; 0 = auto)
HeightOptionalnumber(double)
Height, unit: pt (optional; 0 = auto)
AnchorStringOptionalstring
Anchor keyword text. Required for `anchor` mode; must NOT be set for `absolute` mode.
AnchorXOffsetOptionalnumber(double)
X offset relative to the anchor keyword, unit: pt (optional, default 0). Only valid in `anchor` mode.
AnchorYOffsetOptionalnumber(double)
Y offset relative to the anchor keyword, unit: pt (optional, default 0). Only valid in `anchor` mode.
MatchWholeWordOptionalboolean
Whether to match the keyword as a whole word, default false. Only valid in `anchor` mode.
- `false` (fuzzy): A tab is placed at every occurrence of the keyword in the PDF (other characters may surround it).
- `true` (whole-word): Only matches occurrences with no surrounding characters.
RelativeLocationOptionalstring
Keyword position alignment mode (optional) - anchor mode only, defaults to center alignment if not specified. Available values: Middle (center), Below (directly below), Right (directly right), LowerRight (lower right corner), UpperRight (upper right corner)
MiddleBelowRightLowerRightUpperRight
KeywordIndexesOptionalarray<integer>
Keyword indexes (optional) - anchor mode only. When the PDF contains multiple occurrences of the same keyword, specify which ones to use by index. Index starts from 0, e.g. [0,2] means use the 1st and 3rd keyword positions
TabLabelOptionalstring
Tab label / description
ValueOptionalstring
Preset value
RequiredOptionalboolean
Whether required
ReadOnlyOptionalboolean
Whether read-only
TooltipOptionalstring
Tooltip text
StyleOptionalobject
Font style
FontFamilyOptionalstring
Font family, default Arial. Options: Arial / SimSun / SimHei / Microsoft YaHei / Times New Roman / Courier New
FontSizeOptionalinteger
Font size, default 12, unit pt
FontColorOptionalstring
Font color in hexadecimal, default #000000
BoldOptionalboolean
Whether bold, default false
ItalicOptionalboolean
Whether italic, default false
TextAlignOptionalstring
Text alignment, default left
leftcenterright
CurrentValueOptionalstring
The value actually entered / selected by the signer (applicable to text/checkbox/date)
FilledAtOptionalstring(date-time)
Tab fill time, RFC3339 format
CreatedByOptionalobject
Creator info
UserIdOptionalstring
User ID
NameOptionalstring
User name
EmailOptionalstring
User email
WatermarkOptionalobject
Watermark configuration. Null when envelope has no watermark configured.
SubTypeRequiredstring
Watermark type: CUSTOM_WATERMARK = custom text / PERSON_INFO_WATERMARK = visitor info (only for view/sign stage; not supported for download)
CUSTOM_WATERMARKPERSON_INFO_WATERMARK
TextOptionalstring
Custom text. Required when SubType=CUSTOM_WATERMARK; length 1-50.
ScopeViewOptionalboolean
Whether to overlay watermark in view / online signing stage.
ScopeDownloadOptionalboolean
Whether to overlay watermark on downloaded PDF.
StyleOptionalobject
Render parameters (optional).
FontOptionalstring
Font (default: 黑体). Allowed values: 黑体 / 宋体 / 仿宋
黑体宋体仿宋
FontSizeOptionalinteger
Font size (pt). Range 6-72, default 20.
OpacityOptionalnumber(double)
Opacity. 0 = fully transparent, 1 = fully opaque. Range 0-1, default 0.1.
RotateOptionalinteger
Rotation angle in degrees, clockwise. Range 0-359, default 45.
DensityOptionalinteger
Tile density (effective only when Position=None): 1 = sparse / 2 = standard (default) / 3 = dense
PositionOptionalstring
Watermark position: None = tiled (default) / LeftTop / LeftBottom / RightTop / RightBottom / Center
NoneLeftTopLeftBottomRightTopRightBottomCenter
Error Codes
| Error Code | Description |
|---|---|
INVALID_REQUEST | Request body parsing failed or EnvelopeId is empty |
NOT_FOUND | Envelope does not exist |
INTERNAL_ERROR | Internal service error |