Create Embedded Signature Request

Use files[] to indicate the uploaded file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

Use file_urls[] to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either files or file_urls[], but not both.

Add Signers to your Signature Request.

This endpoint requires either signers or grouped_signers, but not both.

Add Grouped Signers to your Signature Request.

This endpoint requires either signers or grouped_signers, but not both.

Allows signers to decline to sign a document if true. Defaults to false.

Allows signers to reassign their signature requests to other signers if set to true. Defaults to false.

NOTE: Only available for Premium plan.

A list describing the attachments

The email addresses that should be CCed.

Client id of the app you're using to create this embedded signature request. Used for security purposes.

When used together with merge fields, custom_fields allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with form_fields_per_document or Text Tags while passing values back with custom_fields together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling /template/create_embedded_draft and then passing custom_fields on subsequent signature requests referencing that template.

This allows the requester to specify field options for a signature request.

Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups.

Conditional Logic rules for fields defined in form_fields_per_document.

The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.)

NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types.

• Text Field use SubFormFieldsPerDocumentText
• Dropdown Field use SubFormFieldsPerDocumentDropdown
• Hyperlink Field use SubFormFieldsPerDocumentHyperlink
• Checkbox Field use SubFormFieldsPerDocumentCheckbox
• Radio Field use SubFormFieldsPerDocumentRadio
• Signature Field use SubFormFieldsPerDocumentSignature
• Date Signed Field use SubFormFieldsPerDocumentDateSigned
• Initials Field use SubFormFieldsPerDocumentInitials
• Text Merge Field use SubFormFieldsPerDocumentTextMerge
• Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge

Enables automatic Text Tag removal when set to true.

NOTE: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on false and instead hiding your text tags using white text or a similar approach. See the Text Tags Walkthrough for more information.

The custom message in the email that will be sent to the signers.

Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.

This allows the requester to specify the types allowed for creating a signature and specify another signing options.

NOTE: If signing_options are not defined in the request, the allowed types will default to those specified in the account settings.

NOTE: If force_advanced_signature_details is set, allowed types has to be defined too.

The subject in the email that will be sent to the signers.

Whether this is a test, the signature request will not be legally binding if set to true. Defaults to false.

The title you want to assign to the SignatureRequest.

Send with a value of true if you wish to enable Text Tags parsing in your document. Defaults to disabled, or false.

Sent with a value of true to ignore the validation errors from text tags extraction. Defaults to false.

Controls whether auto fill fields can automatically populate a signer's information during signing.

NOTE: Keep your signer's information safe by ensuring that the signer on your signature request is the intended party before using this feature.

When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See Signature Request Expiration Date for details.