ZapSign API
English
English
  • General Information
  • Getting Started
  • ZapSign Environments
  • Ready-to-use requests!
  • Authentication
    • Static token
    • JWT Authentication
      • Get access token
      • Refresh your access token
  • Types of Tokens
  • API versioning
  • Rate Limit Policies
  • Incident alerts
  • How Payment Works
  • Status Code
  • Account
    • Plan Information
    • List account users
    • Create account users
    • Delete account user
  • Documents
    • Create document via Upload
    • OneClick (ClickWrap)
      • Create document (OneClick)
    • Create document via Template
    • Add attachment (extra document)
    • Add attachment (extra document) via Template
    • Detail document
    • List documents
    • Delete document
    • Document Audit Trail
    • Optional: Place signatures
    • Reject Documents
  • Signers
    • Detail signer
    • Update signer
    • Add signer
    • Delete signer
    • Batch sign via API
    • Reject Documents by User
  • Templates
    • Create template (DOCX)
      • Configure Template Form
    • List templates
    • Get template
    • Update template
    • Delete template
  • Partnerships
    • Update Payment Status
    • Create Account
  • TIMESTAMP
    • Add timestamp
  • Background Check
  • Introduction
  • Understanding the Result
  • Creating a Background Check
    • Person Check
    • Company check
  • Retrieve a Check
  • Check details
  • Webhooks
    • How webhooks works
    • Testing webhooks on ZapSign
    • Create Webhook
    • Webhooks logs
    • Events
      • Document
        • Doc created
        • Doc deleted
        • Created signer
      • Signer
        • Signature request send
        • Document viewed
        • Reading confirmation
        • Doc signed
        • Doc refused
        • Email bounce
        • Failed Validation
      • Background check
        • Background check completed
    • Reprocessing Documents and Webhooks
    • Delete Webhook
  • Widget
    • How widget works
Powered by GitBook
On this page

Was this helpful?

  1. Facilitators
  2. SDKs
  3. Typescript SDK
  4. Used Classes
  5. Response

DocResponse

document response class

Last updated 1 year ago

Was this helpful?

Inherited from class.

Properties:

name
type
description

open_id

int

sequencial number of this document inside your company

token

string

Document token

status

string

Document status: "em-curso", "assinado", "recusado" or "lixeira"

original_file

string

Url of original file saved on amazon

signed_file

string

Signed file url saved on amazon

created_through

string

Where this document was created: "web" or "api"

extra_docs

[]

Document extra documents list

deleted

boolean

If True, the document has been deleted

deleted_at

string

Date the document was deleted

created_at

string

Date the document was created

last_update_at

string

Last date the document was updated

template

If the document was created by a model, it contains the model token

answers

[]

List of variables and values ​​for creating this document

auto_reminder

int

Number of times this document will notify signers

signers

[]

represents the list of signers saved in the document

Doc
ExtraDocResponse
Template
Answers
Signer