Workflow Applications: DROPBOXSIGNSEND & DROPBOXSIGNCHECK usage

Development Workflow Applications
1

The DROPBOXSIGNSEND application facilitates the integration of Dropbox Sign services within workflow processes. It allows the sending of documents for e-signature, signer management, and signing experience customization.

The DROPBOXSIGNCHECK application facilitates the integration of Dropbox Sign services within workflow processes. It allows the checking and downloading of documents sent for e-signature.

DROPBOXSIGNSEND

Parameters

General

Name Type Direction Description
API_KEY TEXT IN Dropbox Sign API key
By default, this value comes from the DropboxSignApiKey parameter in the web.config file.
HOST_SERVER TEXT IN Dropbox Sign host server, e.g. https://api.hellosign.com/v3
By default, this value comes from the DropboxSignHostServer parameter in the web.config file.
SIGNERS_JSON TEXT IN JSON representation of the signers
See Send Signature Request and Send with Template in the Dropbox Sign documentation.
DATA_SEPARATOR TEXT IN Separator used in data fields
Default: , (comma).
WITH_ORDER TEXT IN Indicates if signer order must be set: Y (default) or N.
IS_TEMPLATE TEXT IN Indicates if a template is used: Y or N (default)
TEMPLATE_IDS TEXT IN List of the templates’ identifiers, separated by the value defined in the DATA_SEPARATOR parameter
TITLE TEXT IN Title of the document
SUBJECT TEXT IN Subject of the message accompanying the document
MESSAGE TEXT IN Message accompanying the document
ALLOW_DECLINE TEXT IN Indicates if the signer can decline to sign: Y or N (default)
FORM_FIELDS TEXT IN Custom form fields for the document
CUSTOM_FIELDS TEXT IN Custom fields for the document
USE_TEXT_TAGS TEXT IN Indicates if text tags should be used in the document: Y or N (default)
HIDE_TEXT_TAGS TEXT IN Indicates if text tags should be hidden in the document: Y (default) or N
TEST_MODE TEXT IN Enables or disables test mode: Y or N
By default, this value comes from the DropboxSignSendTestMode parameter in the web.config file.
IS_EID TEXT IN Indicates if electronic identification is required: Y or N (default)
FILEX FILE IN File(s) to send, where X corresponds to the file number; you can add one or multiple files
CLIENT_ID TEXT IN Client ID of the app to associate with the signature request; used to apply the branding and callback URL defined for the app
By default, this value comes from the DropboxSignClientId parameter in the web.config file.
SIGNATURE_ID TEXT OUT Contains the signature ID; you can use this ID in the DROPBOXSIGNCHECK_CUSTOM workflow application

With a list of signers

Required parameters

Name Type Direction Description
SIGNER_NAME_LIST TEXT IN Signers’ names, separated by the value defined in the DATA_SEPARATOR parameter
SIGNER_EMAIL_LIST TEXT IN Signers’ email addresses, separated by the value defined in the DATA_SEPARATOR parameter
SIGNER_ROLE_LIST TEXT IN List of the signers’ roles
Note: The role is only required if you use templates.

Optional parameters

Name Type Direction Description
SIGNER_PIN_LIST TEXT IN List of PIN codes for signers’ authentication
SIGNER_PHONE_LIST TEXT IN List of signers’ phone numbers
SIGNER_PHONE_TYPE_LIST TEXT IN List of phone types used by the signers

With signer numbers

Name Type Direction Description
SIGNER_NAMEX TEXT IN Signers’ names, where X corresponds to the signer number; you can add one or multiple signers
SIGNER_EMAILX TEXT IN Signers’ emails, where X corresponds to the signer number; you can add one or multiple signers
SIGNER_ROLEX TEXT IN Signers’ roles, where X corresponds to the signer number; you can add one or multiple signers
Note: The role is only required if you use templates.

Optional parameters

Name Type Direction Description
SIGNER_PINX TEXT IN PIN codes for signers’ authentication, where X corresponds to the signer number
SIGNER_PHONEX TEXT IN Signers’ phone numbers, where X corresponds to the signer number
SIGNER_PHONE_TYPEX TEXT IN Types of phone used by the signers, where X corresponds to the signer number

With signers defined as JSON

You can use the SIGNERS_JSON parameter to define signers.
For more information, see Send Signature Request and Send with Template in the Dropbox Sign documentation.

Examples

Without template

[
  {
    "name": "George",
    "email_address": "george@example.com",
    "order": 0
  },
  {
    "name": "Jack",
    "email_address": "jack@example.com",
    "order": 1
  }
]

With templates

[
  {
    "role": "Client",
    "name": "George",
    "email_address": "george@example.com"
  }
]

DROPBOXSIGNCHECK

Parameters

Name Type Direction Description
API_KEY TEXT IN Dropbox Sign API key
By default, this value comes from the DropboxSignApiKey parameter in the web.config file.
HOST_SERVER TEXT IN Dropbox Sign host server, e.g. https://api.hellosign.com/v3
By default, this value comes from the DropboxSignHostServer parameter in the web.config file.
SIGNATURE_ID TEXT IN Signature ID of the document to check
DOWNLOAD_ON_COMPLETE TEXT IN Indicates if the document should be downloaded when the signature is completed: Y (default) or N
DOWNLOAD_ON_DECLINED TEXT IN Indicates if the document should be downloaded when the signature is declined: Y (default) or N
DOWNLOAD_FILE_TYPE TEXT IN Indicates the format of the document to download: pdf (default) or zip
DOCUMENT FILE OUT Signed document
IS_COMPLETED TEXT OUT Indicates if the signature is completed: Y or N
IS_DECLINED TEXT OUT Indicates if the signature is declined: Y or N
HAS_ERROR TEXT OUT Indicates if the signature has an error: Y or N
FORM_ARCHIVE FILE INOUT Archived HTML snapshot of the workflow form
This allows the module to inject a hyperlink to the downloaded Dropbox Sign document after a signature request is completed or declined.
FORM_ARCHIVE_FILE_FIELD_ID TEXT IN ID of the file field
DOCUMENT_DATA_NAME TEXT IN Data name of the document