Skip to main content
GET
E-Sign Status

E-Sign Status

Returns the current electronic signature status for a specific file. Used to check whether a document has been signed, is pending, or requires action.

Authentication

Requires a valid customer bearer token.

Path Parameters

fileId
number
required
Numeric identifier of the file.

Query Parameters

_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

Returns a HelloSignSignatureStatus object with the e-signature status.

E-Sign Status Fields

Examples

Check e-sign status

TypeScript Integration