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.

• 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.

• 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.

• 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.

2. Click the New API key button.

   

3. Enter a description in the Description field. Select an environment (depending on your usage), then select Full-Access permissions.

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_LIST Default : , (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 parameter The 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 number The 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 parameter The 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 number The 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 number Default: no_otp
FILE_NATUREX	TEXT	IN	Nature of the document of the file to send, where x corresponds to the signer number Default: signable_document
SIGNATURE_WIDTH	TEXT	IN	Signature field width in pixels Default: 25
SIGNATURE_HEIGHT	TEXT	IN	Signature field height in pixels Default: 37

Return parameter

Parameter	Type	Direction	Description
YOUSIGN_SIGNATURE_ID	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
SIGNER_FIRSTNAME_LIST	TEXT	IN	John,Bernard
SIGNER_FIRSTNAME_LIST	TEXT	IN	Bridges,Martin
SIGNER_EMAIL_LIST	TEXT	IN	[email protected],[email protected]
SIGNATURE_NAME	TEXT	IN	Signature on a contract
SIGNER_PAGE_LIST	TEXT	IN	1,2
SIGNER_X_POSITION_LIST	TEXT	IN	100,100
SIGNER_Y_POSITION_LIST	TEXT	IN	100,100
FILE1	FILE	IN	contract.pdf
YOUSIGN_SIGNATURE_ID	TEXT	OUT	xxxxx-xxxxx-xxxxx-xxxxx

With signer numbers

Parameter	Type	Direction	Value
SIGNER_FIRSTNAME1	TEXT	IN	John
SIGNER_LASTNAME1	TEXT	IN	Bridges
SIGNER_FIRSTNAME2	TEXT	IN	Bernard
SIGNER_LASTNAME2	TEXT	IN	Martin
SIGNER_EMAIL1	TEXT	IN	[email protected]
SIGNER_EMAIL2	TEXT	IN	[email protected]
SIGNATURE_NAME	TEXT	IN	Signature on a contract
SIGNER_PAGE1	TEXT	IN	1
SIGNER_PAGE2	TEXT	IN	2
SIGNER_X_POSITION1	TEXT	IN	100
SIGNER_X_POSITION2	TEXT	IN	100
SIGNER_Y_POSITION1	TEXT	IN	100
SIGNER_Y_POSITION2	TEXT	IN	100
FILE1	FILE	IN	contract.pdf
YOUSIGN_SIGNATURE_ID	TEXT	OUT	xxxxx-xxxxx-xxxxx-xxxxx