| url |
string |
|
[optional] |
| team |
\SignRequest\Model\DocumentTeam |
|
[optional] |
| uuid |
string |
|
[optional] |
| user |
\SignRequest\Model\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="#section/Frontend-API/SignRequest-js-client-(beta)">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 |
\SignRequest\Model\InlinePrefillTags[] |
Prefill signer input data, see prefill tags |
[optional] |
| integrations |
\SignRequest\Model\InlineIntegrationData[] |
|
[optional] |
| file_from_sf |
\SignRequest\Model\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 |
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 |
\SignRequest\Model\DocumentSignrequest |
|
[optional] |
| api_used |
bool |
Indicates whether document was created using the API |
[optional] |
| signing_log |
\SignRequest\Model\DocumentSigningLog |
|
[optional] |
| security_hash |
string |
SHA256 hash of PDF contents |
[optional] |
| attachments |
\SignRequest\Model\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] |