YOUSIGNCHECK
Overview
The YOUSIGNCHECK workflow application lets you verify the status of an agreement and download its associated file, which is a concatenation of attached files.
How it works
You can verify the status of an agreement and download the file from Yousign based on your status criteria.
Application logs are available. These can be specified by setting the value of the
YousignCheckLogLevelparameter in theweb.configfile to0to deactivate logs,1for error logs,2for information logs, or3for debug logs; the default value is0.
Configuring the Yousign API
For instructions on how to configure the the Yousign API, see the Configuring the Yousign API section in the YOUSIGNSEND Workflow Application chapter.
Required parameter
Parameter | Type | Direction | Description |
| TEXT | IN | ID of the Yousign signature to verify |
Optional parameters
Yousign configuration
Parameters | 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 | Valid status to download the document Possible values:
Default: |
| FILE | OUT | Yousign document |
| TEXT | OUT | Agreement status |
Example with YOUSIGNSEND
In the following example, the YOUSIGNSEND action is directly followed by the YOUSIGNCHECK action. This action will loop back onto itself until the status changes to done, canceled, expired, deleted, or rejected.
If the status returned meets the condition, the document will be downloaded from Yousign.
With the system loop action function, the YOUSIGNCHECK action will be executed every x seconds until the OUT condition is met.
