> For the complete documentation index, see [llms.txt](https://docs.advantys.com/workflowgen-administration-module-reference-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.advantys.com/workflowgen-administration-module-reference-guide/workflow-applications/yousign/yousignsend.md).

# YOUSIGNSEND

## 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.<br>
* You can specify one or multiple files per YOUSIGNSEND action. To do this, use the `FILEx` parameter, where `x` corresponds to the file number (e.g `FILE1`). At least one file is required.<br>
* You can specify one or multiple signers. To do this, use the combination of `SIGNER_FIRSTNAME_LIST`, `SIGNER_LASTNAME_LIST`, and `SIGNER_EMAIL_LIST`. You can also use `SIGNER_FIRSTNAMEx` , `SIGNER_LASTNAMEx`, and `SIGNER_EMAILx`, where `x` corresponds to the signer number. <br>
* Application logs are available. These can be specified by setting the value of the `YousignSendLogLevel` parameter in the `web.config` file to `0` to deactivate logs, `1` for error logs, `2` for information logs, or `3` for debug logs; the default value is `0`.

## Configuring the Yousign API

### Create a Yousign API application

1. In the Yousign administration interface, click the **Integrations** tab, then select the **API** menu.\
   ![](https://content.gitbook.com/content/imiOCeaawutpXkzp4fhb/blobs/9uPznFRddjCoGVR6QAkj/image.png)<br>

2. Click the **New API key** button.

   <figure><img src="https://content.gitbook.com/content/imiOCeaawutpXkzp4fhb/blobs/Gbko324v1NhJxsb0oPIx/image.png" alt=""><figcaption></figcaption></figure>

3. Enter a description in the **Description** field. Select an environment (depending on your usage), then select **Full-Access** permissions.\
   ![](https://content.gitbook.com/content/imiOCeaawutpXkzp4fhb/blobs/HpSOBpN6PLLLj2h3V1i1/image.png)<br>

## Required parameters

You can use either of the following configurations: with a signers list or with signer numbers.

### With a list of signers

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">First names of signers, separated by the value defined in the <code>DATA_SEPARATOR</code> parameter</td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Last names of signers, separated by the value defined in the <code>DATA_SEPARATOR</code> parameter</td></tr><tr><td valign="top"><code>SIGNER_EMAIL_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Emails of signers, separated by the value defined in the <code>DATA_SEPARATOR</code> parameter</td></tr><tr><td valign="top"><code>FILEx</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top">File(s) to send, where <code>x</code> corresponds to the file number; you can add one or multiple files</td></tr></tbody></table>

### With signer numbers

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAMEx</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">First name(s) of signer(s), where <code>x</code> corresponds to the signer number; you can add one or multiple signers</td></tr><tr><td valign="top"><code>SIGNER_LASTNAMEx</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Last name(s) of signer(s), where <code>x</code> corresponds to the signer number; you can add one or multiple signers</td></tr><tr><td valign="top"><code>SIGNER_EMAILx</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Email(s) of signer(s), where <code>x</code> corresponds to the signer number; you can add one or multiple signers</td></tr><tr><td valign="top"><code>FILEx</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top">File(s) to send, where <code>x</code> corresponds to the file number; you can add one or multiple files</td></tr></tbody></table>

## Optional parameters

### Yousign configuration

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>YOUSIGN_API_KEY</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Yousign API key<br><br>By default, this value comes from the <code>YousignApiKey</code> parameter in the <code>web.config</code> file.</td></tr><tr><td valign="top"><code>YOUSIGN_HOST_SERVER</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Yousign host server (e.g.  <code>https://api.yousign.app/v3</code>)<br></p><p>By default, this value comes from the <code>YousignHostServer</code> parameter in the <code>web.config</code> file.</p></td></tr></tbody></table>

### General

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>DATA_SEPARATOR</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Separator used to separate the content of  <code>SIGNER_FIRSTNAME_LIST</code>, <code>SIGNER_LASTNAME_LIST</code>, <code>SIGNER_EMAIL_LIST</code> , <code>SIGNER_PAGE_LIST</code>,   <code>SIGNER_X_POSITION_LIST</code>, <code>SIGNER_Y_POSTION_LIST</code> , <code>SIGNER_PHONE_LIST</code> , <code>SIGNER_LOCAL_LIST</code>, and <code>SIGNER_AUTH_MODE_LIST</code><br><strong>Default :</strong> <code>,</code> (comma)</td></tr><tr><td valign="top"><code>SIGNER_PAGE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Page to be signed by the signer(s), separated by the value defined in the <code>DATA_SEPARATOR</code> parameter</td></tr><tr><td valign="top"><code>SIGNER_PAGEX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Page to be signed by the signer, where <code>x</code> corresponds to the signer number; you can add one or more signers</td></tr><tr><td valign="top"><code>SIGNER_X_POSITION_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>X position of the signature area for the signer, separated by the value defined in the <code>DATA_SEPARATOR</code> parameter<br></p><p>The value must be a positive numeric integer.</p></td></tr><tr><td valign="top"><code>SIGNER_X_POSITIONX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>X position of the signature area for the signer, where <code>x</code> corresponds to the signer number<br></p><p>The value must be a positive numeric integer.</p></td></tr><tr><td valign="top"><code>SIGNER_Y_POSITION_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Y position of the signature area for the signer, separated by the value defined in the <code>DATA_SEPARATOR</code> parameter<br></p><p>The value must be a positive numeric integer.</p></td></tr><tr><td valign="top"><code>SIGNER_Y_POSITIONX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Y position of the signature area for the signer, where <code>x</code> corresponds to the signer number<br></p><p>The value must be a positive numeric integer.</p></td></tr><tr><td valign="top"><code>SIGNATURE_NAME</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Name of the signature request</td></tr><tr><td valign="top"><code>SIGNER_PHONE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Phone number of the signer(s), separated by the value defined in the <code>DATA_SEPARATOR</code> parameter</td></tr><tr><td valign="top"><code>SIGNER_PHONEX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Signer's phone number, where <code>x</code> is the signer number.</td></tr><tr><td valign="top"><code>SIGNER_LOCALE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Location of the signer(s), separated by the value defined in the <code>DATA_SEPARATOR</code> parameter</td></tr><tr><td valign="top"><code>SIGNER_LOCALEX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Location of the signer, where <code>x</code> is the signer number</td></tr><tr><td valign="top"><code>SIGNER_AUTH_MODE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Authentication mode of the signer(s), separated by the value defined in the <code>DATA_SEPARATOR</code> parameter </td></tr><tr><td valign="top"><code>SIGNER_AUTH_MODEX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Signer authentication mode, where <code>x</code> is the signer number<br></p><p><strong>Default:</strong> <code>no_otp</code> </p></td></tr><tr><td valign="top"><code>FILE_NATUREX</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><p>Nature of the document of the file to send, where <code>x</code> corresponds to the signer number<br></p><p><strong>Default:</strong> <code>signable_document</code></p></td></tr><tr><td valign="top"><code>SIGNATURE_WIDTH</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Signature field width in pixels<br><br><strong>Default:</strong> <code>25</code></td></tr><tr><td valign="top"><code>SIGNATURE_HEIGHT</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top">Signature field height in pixels<br><br><strong>Default:</strong> <code>37</code></td></tr></tbody></table>

### Return parameter

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Description</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Description</strong></td></tr><tr><td valign="top"><code>YOUSIGN_SIGNATURE_ID</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top">Contains the Yousign signature ID; you can use this ID in the YOUSIGNCHECK workflow application</td></tr></tbody></table>

## Examples

### With a list of signers

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Value</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Value</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>John,Bernard</code></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Bridges,Martin</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>john.bridges@mycompany.com,bernard.martin@mycompany.com</code></td></tr><tr><td valign="top"><code>SIGNATURE_NAME</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Signature on a contract</code></td></tr><tr><td valign="top"><code>SIGNER_PAGE_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>1,2</code></td></tr><tr><td valign="top"><code>SIGNER_X_POSITION_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>100,100</code></td></tr><tr><td valign="top"><code>SIGNER_Y_POSITION_LIST</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>100,100</code></td></tr><tr><td valign="top"><code>FILE1</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top"><code>contract.pdf</code></td></tr><tr><td valign="top"><code>YOUSIGN_SIGNATURE_ID</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top"><code>xxxxx-xxxxx-xxxxx-xxxxx</code></td></tr></tbody></table>

### With signer numbers

<table data-header-hidden><thead><tr><th valign="top">Parameter</th><th valign="top">Type</th><th valign="top">Direction</th><th valign="top">Value</th></tr></thead><tbody><tr><td valign="top"><strong>Parameter</strong></td><td valign="top"><strong>Type</strong></td><td valign="top"><strong>Direction</strong></td><td valign="top"><strong>Value</strong></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>John</code></td></tr><tr><td valign="top"><code>SIGNER_LASTNAME1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Bridges</code></td></tr><tr><td valign="top"><code>SIGNER_FIRSTNAME2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Bernard</code></td></tr><tr><td valign="top"><code>SIGNER_LASTNAME2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Martin</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>john.bridges@mycompany.com</code></td></tr><tr><td valign="top"><code>SIGNER_EMAIL2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>bernard.martin@mycompany.com</code></td></tr><tr><td valign="top"><code>SIGNATURE_NAME</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>Signature on a contract</code></td></tr><tr><td valign="top"><code>SIGNER_PAGE1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>1</code></td></tr><tr><td valign="top"><code>SIGNER_PAGE2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>2</code></td></tr><tr><td valign="top"><code>SIGNER_X_POSITION1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>100</code></td></tr><tr><td valign="top"><code>SIGNER_X_POSITION2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>100</code></td></tr><tr><td valign="top"><code>SIGNER_Y_POSITION1</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>100</code></td></tr><tr><td valign="top"><code>SIGNER_Y_POSITION2</code></td><td valign="top">TEXT</td><td valign="top">IN</td><td valign="top"><code>100</code></td></tr><tr><td valign="top"><code>FILE1</code></td><td valign="top">FILE</td><td valign="top">IN</td><td valign="top"><code>contract.pdf</code></td></tr><tr><td valign="top"><code>YOUSIGN_SIGNATURE_ID</code></td><td valign="top">TEXT</td><td valign="top">OUT</td><td valign="top"><code>xxxxx-xxxxx-xxxxx-xxxxx</code></td></tr></tbody></table>
