Skip to main content
GET
/
api
/
public
/
files
/
{fileId}
/
esign
/
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

FieldTypeDescription
SignatureIdstringIdentifier for the signature request
StatusstringCurrent status (pending, signed, declined)
SignedAtstring | nullDate the document was signed
LastViewedAtstring | nullDate the document was last viewed
LastRemindedAtstring | nullDate the last reminder was sent

​
Examples

​
Check e-sign status

GET /api/public/files/22/esign/status
Authorization: Bearer {token}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: status } = useTypedData(httpClient, endpoints.files.esign.status(22))