document

Get document

Changed on
get/document/{docId}/

Request

  • Base URL
    https://eu-api.legalesign.com/api/v1
  • URL
    https://eu-api.legalesign.com/api/v1/document/{docId}/
  • Auth
    API key in header Authorization

Response

successful operation

archivedboolean
auto_archiveboolean

Send document archive very soon after completion.

append_pdfboolean

Append validation information to final PDF

append_historyboolean

Append audit log to final PDF

cc_emailsstring

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

createdstring date-time
do_emailboolean

Use the Legalesign email system

download_finalboolean

Final PDF is available to download

footerstring

HTML docs - text for footer if used

footer_heightinteger

HTMl docs - px height of footer if used

groupstring

Resource URI of group

has_fieldsboolean
hash_valuestring

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

headerstring

HTML docs - text for header if used

header_heightinteger

HTMl docs - px height of header if used

modifiedstring date-time
namestring
pdf_passwordstring

PDF password if used and if save-able

pdf_password_typestring

how pdf password is retained

pdftextstring

ignore this

redirectstring

url for signer redirect after signing

resource_uristring
return_signer_linksboolean

ignore

sign_mouseboolean

legacy attribute

sign_timestring date-time
sign_typeboolean

legacy attribute

sign_uploadboolean

legacy attribute

signature_placementinteger

legacy attribute

signature_typeinteger

legacy - always 4

signers_in_orderboolean
status10 | 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
tagstring

your reference

tag1string

your reference

tag2string

your reference

templatestring
templatepdfstring
textstring
userstring

Resource URI of user

uuidstring uuid

Object ID alone

Changes

  • 5b05b5291b70Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value true was removed for the status

    • info

      response property sign_mouse deprecated

    • info

      response property sign_type deprecated

    • info

      response property sign_upload deprecated

    • info

      response property signature_placement deprecated