Skip to main content

Get document

Get document

Responses

successful operation

Schema
  • archived boolean
  • auto_archive boolean

    Send document archive very soon after signing.

  • cc_emails string

    who will be cc'd with sender on email notification when signed

  • created date-time
  • do_email boolean
  • download_final boolean

    Final PDF is available to download

  • footer string

    HTML docs - text for footer if used

  • footer_height integer

    HTMl docs - px height of footer if used

  • group string

    Resource URI of group

  • has_fields boolean
  • hash_value string

    SHA256 checksum of final doc, use this to validate your final PDF download

  • header string

    HTML docs - text for header if used

  • header_height integer

    HTMl docs - px height of header if used

  • modified date-time
  • name string
  • pdf_password string

    PDF password if used and if save-able

  • pdf_password_type string

    how pdf password is retained

  • pdftext string

    ignore this

  • redirect string

    url for signer redirect after signing

  • resource_uri string
  • return_signer_links boolean

    ignore

  • sign_mouse boolean

    legacy

  • sign_time date-time
  • sign_type boolean

    legacy

  • sign_upload boolean

    legacy

  • signature_placement integer

    legacy

  • signature_type integer

    legacy - always 4

  • signers array[]

    nested arrays with signer details

  • signers_in_order boolean
  • status integer

    Possible values: [10, 20, 30, 40, 50]

    Document status options:

    • 10 - Initial state, check signer status for sent/unsent
    • 20 - Fields completed
    • 30 - Signed
    • 40 - Removed (before signing)
    • 50 - Rejected
  • tag string

    your reference

  • template string
  • templatepdf string
  • text string
  • user string

    Resource URI of user

  • uuid uuid

    Object ID alone