SIsignnow

Get document

This endpoint allows API users to retrieve the details of a document.

The Document object contains:

  • Metadata: file name, size, extension, and ID
  • Fields, texts, checks, and signatures
  • Invites and their statuses (available statuses are: created, pending, fulfilled, canceled, skipped)
  • Roles:
    • Recipients with a sign action appear in the roles array.
    • Recipients with an approve action appear in the approver_roles array.
    • Recipients with a view action appear in the viewer_roles array.
  • Timestamps (date created, and date updated)
  • Document group information
  • Document group template information
  • Originator's organization-level settings
  • Integrations settings
  • Signing session settings
  • Share information
    • is_team_shared: Returns true, if the file has been shared with a team.
    • role: Indicates the user's access to the document: Allowed values are sender, viewer, or owner.
    • is_personally_shared_to_others: Returns true if the template has been personally shared with other users (via the Share button). The attribute is visible to the template owner and users with access rights.

Document is a fundamental object of every eSignature workflow.

  • To send an invite, select or upload a document.
  • When the document is signed, it can be downloaded in PDF file format.
  • Documents in SignNow can be turned into templates.
  • API also allows you to create event subscriptions triggered by a specific document.
get/document/{document_id}

Request

Path parameters

Document ID.

Query parameters

If used, the response will contain the list of smart fields.

If used, the response will contain document attributes.

Response

Successful response. Returns the document with its fields, roles, invites, and settings. To also return smart fields, add include=integration_objects.

idstring

Unique identifier of the document.

linesobject[]

List of line elements drawn on the document.

ownerstring

Email address of the document owner.

sealsobject[]

List of applied seal elements on the document.

textsobject[]

List of text elements added to the document.

checksobject[]

List of checkmark elements added to the document.

createdstring

Unix timestamp when the document was created.

insertsobject[]

List of text inserts added to the document.

updatedstring

Unix timestamp of the last document update.

user_idstring

Unique identifier of the document owner.

paymentsobject[]

List of payment requests attached to the document.

requestsobject[]

List of document requests.

settingsobject

Document-level settings and feature flags.

templateboolean

Indicates whether the document is a template. true if it is a template, false otherwise.

parent_idstring

Identifier of the parent document.

hyperlinksobject[]

List of hyperlink elements on the document.

owner_namestring

Display name of the document owner.

page_countstring

Number of pages in the document, as a string.

exported_toobject[]

List of destinations to which the document has been exported.

integrationsobject[]

List of third-party integrations associated with the document.

radiobuttonsobject[]

List of radio button groups on the document.

version_timestring

Unix timestamp of the document version.

viewer_rolesobject[]

List of viewer roles defined for the document.

document_namestring

Name of the document.

approver_rolesobject[]

List of approver roles defined for the document.

notary_invitesobject[]

List of notary invites on the document.

origin_user_idstring

Identifier of the user who owns the source document. Can be null.

checkbox_groupsobject[]

List of checkbox group definitions on the document.

originator_logostring

URL reference to the document originator's logo.

scheduled_inviteobject

Scheduled invite configuration. Can be null if no invite is scheduled.

original_filenamestring

Original filename of the uploaded document.

origin_document_idstring

Identifier of the source document if this document was created as a copy. Can be null.

enumeration_optionsobject[]

List of enumeration options for dropdown fields.

viewer_field_invitesobject[]

List of viewer field invites for the document.

approver_field_invitesobject[]

List of approver field invites for the document.

Changes

No recorded changes to this operation across all 1 revision of this API.