Skip to content

Latest commit

 

History

History
34 lines (30 loc) · 3.61 KB

SignatureRequestResponse.md

File metadata and controls

34 lines (30 loc) · 3.61 KB
Raw

Dropbox::Sign::SignatureRequestResponse

Contains information about a signature request.

Properties

Name Type Description Notes
test_mode Boolean Whether this is a test signature request. Test requests have no legal value. Defaults to false. [default to false]
signature_request_id String The id of the SignatureRequest.
requester_email_address String The email address of the initiator of the SignatureRequest.
title String The title the specified Account uses for the SignatureRequest.
original_title String Default Label for account.
subject String The subject in the email that was initially sent to the signers.
message String The custom message in the email that was initially sent to the signers.
metadata Object The metadata attached to the signature request.
created_at Integer Time the signature request was created.
expires_at Integer The time when the signature request will expire unsigned signatures. See Signature Request Expiration Date for details.
is_complete Boolean Whether or not the SignatureRequest has been fully executed by all signers.
is_declined Boolean Whether or not the SignatureRequest has been declined by a signer.
has_error Boolean Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
files_url String The URL where a copy of the request's documents can be downloaded.
signing_url String The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing Dropbox Sign accounts as they will be required to log in before signing.
details_url String The URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addresses Array<String> A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.
signing_redirect_url String The URL you want the signer redirected to after they successfully sign.
final_copy_uri String The path where the completed document can be downloaded
template_ids Array<String> Templates IDs used in this SignatureRequest (if any).
custom_fields Array<SignatureRequestResponseCustomFieldBase> An array of Custom Field objects containing the name and type of each custom field.

* Text Field uses SignatureRequestResponseCustomFieldText
* Checkbox Field uses SignatureRequestResponseCustomFieldCheckbox
attachments Array<SignatureRequestResponseAttachment> Signer attachments.
response_data Array<SignatureRequestResponseDataBase> An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
signatures Array<SignatureRequestResponseSignatures> An array of signature objects, 1 for each signer.
bulk_send_job_id String The ID of the Bulk Send job which sent the signature request, if applicable.