Skip to content

Latest commit

 

History

History
39 lines (35 loc) · 3.81 KB

Document.md

File metadata and controls

39 lines (35 loc) · 3.81 KB

Document

Properties

Name Type Description Notes
url str [optional]
team DocumentTeam [optional]
uuid str [optional]
user User [optional]
file_as_pdf str Temporary URL to original file as PDF, expires in five minutes [optional]
name str Defaults to filename, including extension [optional]
external_id str ID used to reference document in external system [optional]
frontend_id str 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 str Temporary URL to original file, expires in five minutes [optional]
file_from_url str Publicly accessible URL of document to be downloaded by SignRequest [optional]
events_callback_url str URL at which to receive event callbacks for this document [optional]
file_from_content str Base64 encoded document content [optional]
file_from_content_name str Filename, including extension. Required when using `file_from_content`. [optional]
template str [optional]
prefill_tags list[InlinePrefillTags] Prefill signer input data, see prefill tags [optional]
integrations list[InlineIntegrationData] [optional]
file_from_sf FileFromSf [optional]
auto_delete_days int Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted [optional]
auto_expire_days int Number of days after which a non finished document will be automatically expired [optional]
pdf str Temporary URL to signed document as PDF, expires in five minutes [optional]
status str `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 bool Indicates whether document was created using the API [optional]
signing_log DocumentSigningLog [optional]
security_hash str SHA256 hash of PDF contents [optional]
attachments list[DocumentAttachment] [optional]
auto_delete_after datetime Date and time calculated using `auto_delete_days` after which a finished document (signed/cancelled/declined) will be automatically deleted [optional]
sandbox bool Indicates whether document was created as part of a sandbox team [optional]
auto_expire_after datetime Date and time calculated using `auto_expire_days` after which a non finished document will be automatically expired [optional]
processing bool Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed. [optional]

[Back to Model list] [Back to API list] [Back to README]