Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 3.77 KB

Document.md

File metadata and controls

67 lines (47 loc) · 3.77 KB

SignrequestClient.Document

Properties

Name Type Description Notes
url String [optional]
team DocumentTeam [optional]
uuid String [optional]
user User [optional]
file_as_pdf String Temporary URL to original file as PDF, expires in five minutes [optional]
name String Defaults to filename, including extension [optional]
external_id String ID used to reference document in external system [optional]
frontend_id String Shared secret used in conjunction with <a href=&quot;#section/Frontend-API/SignRequest-js-client-(beta)&quot;>SignRequest-js client</a> to grant user access to a document that's not a member of the document's team [optional]
file String Temporary URL to original file, expires in five minutes [optional]
file_from_url String Publicly accessible URL of document to be downloaded by SignRequest [optional]
events_callback_url String URL at which to receive event callbacks for this document [optional]
file_from_content String Base64 encoded document content [optional]
file_from_content_name String Filename, including extension. Required when using `file_from_content`. [optional]
template String [optional]
prefill_tags [InlinePrefillTags] Prefill signer input data, see prefill tags [optional]
integrations [InlineIntegrationData] [optional]
file_from_sf FileFromSf [optional]
auto_delete_days Number Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted [optional]
auto_expire_days Number Number of days after which a non finished document will be automatically expired [optional]
pdf String Temporary URL to signed document as PDF, expires in five minutes [optional]
status String `co`: converting, `ne`: new, `se`: sent, `vi`: viewed, `si`: signed, `do`: downloaded, `sd`: signed and downloaded, `ca`: cancelled, `de`: declined, `ec`: error converting, `es`: error sending, `xp`: expired [optional]
signrequest DocumentSignrequest [optional]
api_used Boolean Indicates whether document was created using the API [optional]
signing_log DocumentSigningLog [optional]
security_hash String SHA256 hash of PDF contents [optional]
attachments [DocumentAttachment] [optional]
auto_delete_after Date Date and time calculated using `auto_delete_days` after which a finished document (signed/cancelled/declined) will be automatically deleted [optional]
sandbox Boolean Indicates whether document was created as part of a sandbox team [optional]
auto_expire_after Date Date and time calculated using `auto_expire_days` after which a non finished document will be automatically expired [optional]

Enum: StatusEnum

  • co (value: "co")

  • ne (value: "ne")

  • se (value: "se")

  • vi (value: "vi")

  • si (value: "si")

  • do (value: "do")

  • sd (value: "sd")

  • ca (value: "ca")

  • de (value: "de")

  • ec (value: "ec")

  • es (value: "es")

  • xp (value: "xp")