Skip to content

Latest commit

 

History

History
38 lines (35 loc) · 3.87 KB

Document.md

File metadata and controls

38 lines (35 loc) · 3.87 KB

SignRequest.Model.Document

Properties

Name Type Description Notes
Url string [optional]
Team DocumentTeam [optional]
Uuid string [optional]
User User [optional]
FileAsPdf string Temporary URL to original file as PDF, expires in five minutes [optional]
Name string Defaults to filename, including extension [optional]
ExternalId string ID used to reference document in external system [optional]
FrontendId 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]
FileFromUrl string Publicly accessible URL of document to be downloaded by SignRequest [optional]
EventsCallbackUrl string URL at which to receive event callbacks for this document [optional]
FileFromContent string Base64 encoded document content [optional]
FileFromContentName string Filename, including extension. Required when using `file_from_content`. [optional]
Template string [optional]
PrefillTags List<InlinePrefillTags> Prefill signer input data, see prefill tags [optional]
Integrations List<InlineIntegrationData> [optional]
FileFromSf FileFromSf [optional]
AutoDeleteDays int? Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted [optional]
AutoExpireDays int? 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]
ApiUsed bool? Indicates whether document was created using the API [optional]
SigningLog DocumentSigningLog [optional]
SecurityHash string SHA256 hash of PDF contents [optional]
Attachments List<DocumentAttachment> [optional]
AutoDeleteAfter 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]
AutoExpireAfter 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]