OPENAPI / COMPONENTS / SCHEMAS
Signature Request Response
SignatureRequestResponseContains information about a signature request.
test_modebooleanWhether this is a test signature request. Test requests have no legal value. Defaults to `false`.
signature_request_idstringThe id of the SignatureRequest.
requester_email_addressstringThe email address of the initiator of the SignatureRequest.
titlestringThe title the specified Account uses for the SignatureRequest.
original_titlestringDefault Label for account.
subjectstringThe subject in the email that was initially sent to the signers.
messagestringThe custom message in the email that was initially sent to the signers.
metadataobjectThe metadata attached to the signature request.
created_atintegerTime the signature request was created.
expires_atintegerThe 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_completebooleanWhether or not the SignatureRequest has been fully executed by all signers.
is_declinedbooleanWhether or not the SignatureRequest has been declined by a signer.
has_errorbooleanWhether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).
files_urlstringThe URL where a copy of the request's documents can be downloaded.
signing_urlstringThe 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_urlstringThe URL where the requester and the signers can view the current status of the SignatureRequest.
cc_email_addressesarrayA 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_urlstringThe URL you want the signer redirected to after they successfully sign.
final_copy_uristringThe path where the completed document can be downloaded
template_idsarrayTemplates IDs used in this SignatureRequest (if any).
custom_fieldsSignatureRequestResponseCustomFieldBaseAn array of Custom Field objects containing the name and type of each custom field. * Text Field uses `SignatureRequestResponseCustomFieldText` * Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
attachmentsSignatureRequestResponseAttachmentSigner attachments.
response_dataSignatureRequestResponseDataBaseAn array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
signaturesSignatureRequestResponseSignaturesAn array of signature objects, 1 for each signer.
bulk_send_job_idstringThe ID of the Bulk Send job which sent the signature request, if applicable.