OPENAPI / COMPONENTS / SCHEMAS

Signature Request Response

SignatureRequestResponse

Contains information about a signature request.

object25properties
test_modeboolean

Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.

signature_request_idstring

The id of the SignatureRequest.

requester_email_addressstring

The email address of the initiator of the SignatureRequest.

titlestring

The title the specified Account uses for the SignatureRequest.

original_titlestring

Default Label for account.

subjectstring

The subject in the email that was initially sent to the signers.

messagestring

The custom message in the email that was initially sent to the signers.

metadataobject

The metadata attached to the signature request.

created_atinteger

Time the signature request was created.

expires_atinteger

The time when the signature request will expire unsigned signatures. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.

is_completeboolean

Whether or not the SignatureRequest has been fully executed by all signers.

is_declinedboolean

Whether or not the SignatureRequest has been declined by a signer.

has_errorboolean

Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).

files_urlstring

The URL where a copy of the request's documents can be downloaded.

signing_urlstring

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_urlstring

The URL where the requester and the signers can view the current status of the SignatureRequest.

cc_email_addressesarray

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_urlstring

The URL you want the signer redirected to after they successfully sign.

final_copy_uristring

The path where the completed document can be downloaded

template_idsarray

Templates IDs used in this SignatureRequest (if any).

custom_fieldsSignatureRequestResponseCustomFieldBase

An array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`

attachmentsSignatureRequestResponseAttachment

Signer attachments.

response_dataSignatureRequestResponseDataBase

An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.

signaturesSignatureRequestResponseSignatures

An array of signature objects, 1 for each signer.

bulk_send_job_idstring

The ID of the Bulk Send job which sent the signature request, if applicable.