Constants

Field types

These are the options you can specify for the type field.

Form fields per document

Different field types may have different options available to them within the form_fields_per_document parameter.

Checkbox field grouping

Checkbox field groups accept an optional validation rule, which must be met before the user can submit the signed document. These are the options you can specify for validation rule.

Radio field grouping

Radio field groups must define a validation rule, which must be met before the user can submit the signed document. These are the options you can specify for validation rule.

Conditional logic

Conditional logic allows adding an "if this, then that" flow to signature requests.

Notes about conditional logic:

1. Conditional logic can only be set up for one trigger field, not a combination of fields. For example, you can't specify IF dropdown = option1 **AND** textbox = "cat" , then show these selected fields.
2. Conditional logic, both triggered and selected fields, must be limited to a specific signer. You can't set up a trigger field that, when complete by one signer, triggers fields for another signer.
3. A field can act as a trigger field for multiple conditions. However, a field can only act as a selected field once.
4. See our Adding conditional logic to documents page for more information on how conditional logic works within the Editor.

Signature status codes

The Signature Request response object contains a list of associated signatures. Each signature entry includes a status_code field that describes its current state. The table below lists all possible codes.

Data validation types

Text fields accept an optional validation type, which must be met before the user can submit the signed document. This value can be specified in form fields, text tags, or on the web. These are the options you can specify for validation type.

Notes about data validation types: When using custom_regex you are required to pass a second parameter, validation_custom_regex, and you can optionally provide validation_custom_regex_format_label for the error message the user will see in case of an invalid value. Here's an example:

  "validation_type": "custom_regex",
  "validation_custom_regex": "A[0-9]{3}",
  "validation_custom_regex_format_label": "A000",

Populate Auto-Fill Fields

populate_auto_fill_fields is a new parameter we introduced to Dropbox Sign embedded API endpoints to give users more flexibility to choose which signature requests have auto-fill. This parameter enables auto-populating (Auto-Fill) fields for your signature requests. This feature pulls information from your signers, provided from either their own Dropbox Sign profile or from the name and email address entered in by the requester, and populates the information into the corresponding fields.

Here's an example using cURL:

 
curl -X POST 'https://api.hellosign.com/v3/signature_request/create_embedded' \
  -u 'YOUR_API_KEY:' \
  -F 'client_id=YOUR_CLIENT_ID' \
  -F 'files[0]=@mutual-NDA-example.pdf' \
  -F 'signers[0][email_address]=jack@example.com' \
  -F 'signers[0][name]=Jack' \
  -F 'test_mode=1' \
  -F 'populate_auto_fill_fields=1'

The available Auto-Fill fields are listed in the next section below.

Auto Fill types

Text fields accept an optional auto fill type. This value can be specified in form fields, text tags, or on the web. Below are the options you can specify for auto fill type.

Notes about auto fill types: Label, id, or validation can be skipped with the following example: [text|req|signer1||||firstName]

Date formats

Supported locales

These are the locales you can specify for the locale field. They're case-sensitive. Note that this only affects locale preference in the settings page.