Get document

Get document

Path Parameters

• docId uuid required

  document id

Responses

• 200

---

successful operation

application/json

• Schema
• Example (from schema)

---

Schema

• archived boolean
• auto_archive boolean

  Default value: true

  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

• tag1 string

  your reference

• tag2 string

  your reference

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

  Resource URI of user

• uuid uuid

  Object ID alone

[
  {
    "archived": false,
    "auto_archive": true,
    "cc_emails": "None",
    "created": "2020-05-20T:15:10",
    "do_email": false,
    "download_final": false,
    "footer": "",
    "footer_height": null,
    "group": "/api/v1/group/my-group/",
    "has_fields": true,
    "hash_value": "None",
    "header": "",
    "header_height": "None",
    "modified": "2020-05-20T:15:10",
    "name": "test cs_agreement",
    "pdf_password": "None",
    "pdf_password_type": "None",
    "pdftext": "None",
    "redirect": "https://example.com/redirect-receive/",
    "resource_uri": "/api/v1/document/d0d0d0d0-d0fd0-d0d0-d0d0-d0d0d0d0d0d0/",
    "return_signer_links": false,
    "sign_mouse": true,
    "sign_time": "None",
    "sign_type": true,
    "sign_upload": true,
    "signature_placement": 2,
    "signature_type": 4,
    "signers": [
      "/api/v1/signers/s0s0s0s0-s0s0-s0s0-s0s0-s0s0s0s0s0s0/, John, Smith, john.smith@example.comma, '', true, 20, 0",
      "/api/v1/signers/s1s1s1s1-s1s1-s1s1-s1s1-s1s1s1s1s1s1/, Betty, MacLean, betty.maclean@example.comma, '', true, 10, 1"
    ],
    "signer_in_order": true,
    "status": 10,
    "tag": "contract2020myref",
    "tag1": "my_other_ref",
    "tag2": "andFinalRef",
    "template": "None",
    "templatepdf": "/api/v1/templatepdf/p0p0p0p0-p0p0-p0p0-p0p0-p0p0p0p0p0p0/",
    "text": "",
    "user": "/api/v1/user/u0u0u0u0-u0u0-u0u0-u0u0-u0u0u0u0u0u0/",
    "uuid": "d0d0d0d0-d0fd0-d0d0-d0d0-d0d0d0d0d0d0"
  }
]

Loading...