The YOUSIGNSEND workflow application lets you send one or more documents to Yousign for electronic signature.
The YOUSIGNCHECK workflow application lets you verify the status of an agreement and download its associated file, which is a concatenation of attached files.
For more information and complete instructions on how to use the applications, including how to configure the Yousign API, as well as an example, see the YOUSIGNSEND Workflow Application and YOUSIGNCHECK Workflow Application sections in the WorkflowGen Administration Guide.
YOUSIGNSEND
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 |
|---|---|---|---|
SIGNER_FIRSTNAME_LIST |
TEXT | IN | First names of signers, separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_FIRSTNAME_LIST |
TEXT | IN | Last names of signers, separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_EMAIL_LIST |
TEXT | IN | Emails of signers, separated by the value defined in the DATA_SEPARATOR parameter |
FILEx |
FILE | IN | File(s) to send, where x corresponds to the file number; you can add one or multiple files |
With signer numbers
| Parameter | Type | Direction | Description |
|---|---|---|---|
SIGNER_FIRSTNAMEx |
TEXT | IN | First name(s) of signer(s), where x corresponds to the signer number; you can add one or multiple signers |
SIGNER_LASTNAMEx |
TEXT | IN | Last name(s) of signer(s), where x corresponds to the signer number; you can add one or multiple signers |
SIGNER_EMAILx |
TEXT | IN | Email(s) of signer(s), where x corresponds to the signer number; you can add one or multiple signers |
FILEx |
FILE | IN | File(s) to send, where x corresponds to the file number; you can add one or multiple files |
Optional parameters
Yousign configuration
| Parameter | Type | Direction | Description |
|---|---|---|---|
YOUSIGN_API_KEY |
TEXT | IN | Yousign API key By default, this value comes from the YousignApiKey parameter in the web.config file. |
YOUSIGN_HOST_SERVER |
TEXT | IN | Yousign host server (e.g. https://api.yousign.app/v3 )By default, this value comes from the YousignHostServer parameter in the web.config file. |
General
| Parameter | Type | Direction | Description |
|---|---|---|---|
DATA_SEPARATOR |
TEXT | IN | Separator used to separate the content of SIGNER_FIRSTNAME_LIST, SIGNER_LASTNAME_LIST, SIGNER_EMAIL_LIST, SIGNER_PAGE_LIST, SIGNER_X_POSITION_LIST, SIGNER_Y_POSTION_LIST, SIGNER_PHONE_LIST, SIGNER_LOCAL_LIST, and SIGNER_AUTH_MODE_LISTDefault: , (comma) |
SIGNER_PAGE_LIST |
TEXT | IN | Page to be signed by the signer(s), separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_PAGEX |
TEXT | IN | Page to be signed by the signer, where x corresponds to the signer number; you can add one or more signers |
SIGNER_X_POSITION_LIST |
TEXT | IN | X position of the signature area for the signer, separated by the value defined in the DATA_SEPARATOR parameterThe value must be a positive numeric integer. |
SIGNER_X_POSITIONX |
TEXT | IN | X position of the signature area for the signer, where x corresponds to the signer numberThe value must be a positive numeric integer. |
SIGNER_Y_POSITION_LIST |
TEXT | IN | Y position of the signature area for the signer, separated by the value defined in the DATA_SEPARATOR parameterThe value must be a positive numeric integer. |
SIGNER_Y_POSITIONX |
TEXT | IN | Y position of the signature area for the signer, where x corresponds to the signer numberThe value must be a positive numeric integer. |
SIGNATURE_NAME |
TEXT | IN | Name of the signature request |
SIGNER_PHONE_LIST |
TEXT | IN | Phone number of the signer(s), separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_PHONEX |
TEXT | IN | Signer’s phone number, where x is the signer number. |
SIGNER_LOCALE_LIST |
TEXT | IN | Location of the signer(s), separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_LOCALEX |
TEXT | IN | Location of the signer, where x is the signer number |
SIGNER_AUTH_MODE_LIST |
TEXT | IN | Authentication mode of the signer(s), separated by the value defined in the DATA_SEPARATOR parameter |
SIGNER_AUTH_MODEX |
TEXT | IN | Signer authentication mode, where x is the signer numberDefault: no_otp |
FILE_NATUREX |
TEXT | IN | Nature of the document of the file to send, where x corresponds to the signer numberDefault: signable_document |
SIGNATURE_WIDTH |
TEXT | IN | Signature field width in pixels Default: 25 |
SIGNATURE_HEIGHT |
TEXT | IN | Signature field height in pixels Default: 37 |
YOUSIGNCHECK
Required parameter
| Parameter | Type | Direction | Description |
|---|---|---|---|
YOUSIGN_SIGNATURE_ID |
TEXT | IN | ID of the Yousign signature to verify |
Optional parameters
Yousign configuration
| Parameters | Type | Direction | Description |
|---|---|---|---|
YOUSIGN_API_KEY |
TEXT | IN | Yousign API key By default, this value comes from the YousignApiKey parameter in the web.config file. |
YOUSIGN_HOST_SERVER |
TEXT | IN | Yousign host server (e.g.: https://api.yousign.app/v3)By default, this value comes from the YousignHostServer parameter in the web.config file. |
General
| Parameter | Type | Direction | Description |
|---|---|---|---|
VALID_STATUS_LIST |
TEXT | IN | Valid status to download the document Possible values:
done,canceled,expired,deleted,rejected |
YOUSIGN_DOCUMENT |
FILE | OUT | Yousign document |
YOUSIGN_STATUS |
TEXT | OUT | Agreement status |