Create Embedded Signature Request


Creates a new SignatureRequest with the submitted documents to be signed in an embedded iFrame. If form_fields_per_document is not specified, a signature page will be affixed where all signers will be required to add their signature, signifying their agreement to all contained documents. Note that embedded signature requests can only be signed in embedded iFrames whereas normal signature requests can only be signed on Dropbox Sign.

Securityapi_key or oauth2
Request Body schema:

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

Array of objects (SubSignatureRequestSigner)

Add Signers to your Signature Request.

Array of strings <binary>

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

This endpoint requires either file or file_url[], but not both.

Array of strings

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

This endpoint requires either file or file_url[], but not both.

Default: false

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

Default: false

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

Note: Only available for Premium plan.

Array of objects (SubAttachment)

A list describing the attachments

Array of strings <email>

The email addresses that should be CCed.

Array of objects (SubCustomField)

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.

object (SubFieldOptions)

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

Array of objects (SubFormFieldGroup)

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.

Array of objects (SubFormFieldRule)

Conditional Logic rules for fields defined in form_fields_per_document.

Array of objects (SubFormFieldsPerDocumentBase)

The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. 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
Default: false

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.

string <= 5000 characters

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

object <= 10 items

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.

object (SubSigningOptions)

This allows the requester to specify the types allowed for creating a signature.

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

string <= 255 characters

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

Default: false

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

string <= 255 characters

The title you want to assign to the SignatureRequest.

Default: false

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

Default: 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.

Feature only available in closed beta. Contact us to request access.
integer or null

When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable.

Note This does not correspond to the expires_at returned in the response.

Feature only available in closed beta. Contact us to request access.

successful operation



Request samples
  • "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a",
  • "title": "NDA with Acme Co.",
  • "subject": "The NDA we talked about",
  • "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.",
  • "signers": [
  • "cc_email_addresses": [
  • "signing_options": {
  • "test_mode": true
Response samples
  • "signature_request": {