YOUSIGNSEND Workflow Application
Overview
The YOUSIGNSEND workflow application lets you send one or more documents to Yousign for electronic signature.
How it works
The YOUSIGNSEND application will create a unique envelope and send it to one or multiple signers.
You can specify one or multiple files per YOUSIGNSEND action. To do this, use the
FILEx
parameter, wherex
corresponds to the file number (e.gFILE1
). At least one file is required.You can specify one or multiple signers. To do this, use the combination of
SIGNER_FIRSTNAME_LIST
,SIGNER_LASTNAME_LIST
, andSIGNER_EMAIL_LIST
. You can also useSIGNER_FIRSTNAMEx
,SIGNER_LASTNAMEx
, andSIGNER_EMAILx
, wherex
corresponds to the signer number.Application logs are available. These can be specified by setting the value of the
YousignSendLogLevel
parameter in theweb.config
file to0
to deactivate logs,1
for error logs,2
for information logs, or3
for debug logs; the default value is0
.
Configuring the Yousign API
Create a Yousign API application
Click the New API key button.
Required parameters
You can use either of the following configurations: with a signers list or with signer numbers.
With a list of signers
Parameter | Type | Direction | Description |
| TEXT | IN | First names of signers, separated by the value defined in the |
| TEXT | IN | Last names of signers, separated by the value defined in the |
| TEXT | IN | Emails of signers, separated by the value defined in the |
| FILE | IN | File(s) to send, where |
With signer numbers
Parameter | Type | Direction | Description |
| TEXT | IN | First name(s) of signer(s), where |
| TEXT | IN | Last name(s) of signer(s), where |
| TEXT | IN | Email(s) of signer(s), where |
| FILE | IN | File(s) to send, where |
Optional parameters
Yousign configuration
Parameter | Type | Direction | Description |
| TEXT | IN | Yousign API key
By default, this value comes from the |
| TEXT | IN | Yousign host server (e.g. By default, this value comes from the |
General
Parameter | Type | Direction | Description |
| TEXT | IN | Separator used to separate the content of |
| TEXT | IN | Page to be signed by the signer(s), separated by the value defined in the |
| TEXT | IN | Page to be signed by the signer, where |
| TEXT | IN | X position of the signature area for the signer, separated by the value defined in the The value must be a positive numeric integer. |
| TEXT | IN | X position of the signature area for the signer, where The value must be a positive numeric integer. |
| TEXT | IN | Y position of the signature area for the signer, separated by the value defined in the The value must be a positive numeric integer. |
| TEXT | IN | Y position of the signature area for the signer, where The value must be a positive numeric integer. |
| TEXT | IN | Name of the signature request |
| TEXT | IN | Phone number of the signer(s), separated by the value defined in the |
| TEXT | IN | Signer's phone number, where |
| TEXT | IN | Location of the signer(s), separated by the value defined in the |
| TEXT | IN | Location of the signer, where |
| TEXT | IN | Authentication mode of the signer(s), separated by the value defined in the |
| TEXT | IN | Signer authentication mode, where Default: |
| TEXT | IN | Nature of the document of the file to send, where Default: |
| TEXT | IN | Signature field width in pixels
Default: |
| TEXT | IN | Signature field height in pixels
Default: |
Return parameter
Parameter | Type | Direction | Description |
| TEXT | OUT | Contains the Yousign signature ID; you can use this ID in the YOUSIGNCHECK workflow application |
Examples
With a list of signers
Parameter | Type | Direction | Value |
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| FILE | IN |
|
| TEXT | OUT |
|
With signer numbers
Parameter | Type | Direction | Value |
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| TEXT | IN |
|
| FILE | IN |
|
| TEXT | OUT |
|
Last updated