> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/yousign.md).

# Yousign

Send documents out for electronic signature, track signing progress, and download signed documents and audit trails.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Yousign   | API Key        |

### Yousign

Connect to Yousign to send documents for e-signature, track signing progress, and download signed documents and audit trails.

#### Set up in Yousign

1. Prepare the Yousign account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Your Yousign API key, created under Settings > API keys. Sent as 'Authorization: Bearer {key}'. A production key only works against the production environment, and a sandbox key only against sandbox.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Yousign**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required                 | What to enter                                                                                                                                                                                                                                                                   |
| ------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes                      | Your Yousign API key, created under Settings > API keys. Sent as 'Authorization: Bearer {key}'. A production key only works against the production environment, and a sandbox key only against sandbox. [Provider instructions](https://developers.youtrust.com/docs/api-keys). |
| Environment   | Optional / as applicable | Which Yousign environment this API key belongs to. Production and sandbox keys are separate and cannot be used against the other environment.                                                                                                                                   |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **Yousign** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Send Document for Signature

Send a document out for signature in one step: creates the request, uploads your document, adds the signer, and activates it so they are notified.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                                                                               |
| --------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Request Name          | string          | Yes      | Name of the signature request, shown to the signer.                                                                                                                                       |
| Document URL          | string          | Yes      | Link to the document to sign (PDF or DOCX). It is fetched and uploaded for you.                                                                                                           |
| Signer First Name     | string          | Yes      | First name of the person who will sign.                                                                                                                                                   |
| Signer Last Name      | string          | Yes      | Last name of the person who will sign.                                                                                                                                                    |
| Signer Email          | string          | Yes      | Email address where the signature invitation is sent.                                                                                                                                     |
| Signature Level       | select (string) | No       | Legal strength of the signature. Simple electronic signature suits most documents. Available values: Electronic Signature, Advanced Electronic Signature, Qualified Electronic Signature. |
| Show Advanced Options | boolean         | No       | Show document name, signer verification, delivery, field placement, and expiration settings.                                                                                              |
| Document Name         | string          | No       | Optional file name to show instead of the one from the URL.                                                                                                                               |
| Signer Phone Number   | string          | No       | Signer's mobile number, only needed for SMS code verification.                                                                                                                            |
| Signer Language       | select (string) | No       | Language used in emails and the signing page for this signer. Available values: English, French, German, Italian, Dutch, Spanish, Polish, Portuguese, Romanian.                           |
| Signer Verification   | select (string) | No       | How the signer proves it is them: a code by email, a code by SMS, or no code. Available values: Code by Email, Code by SMS, No Code.                                                      |
| Delivery Mode         | select (string) | No       | How the signer is invited: by email from Yousign, or not at all (you share the link yourself). Available values: Email, None.                                                             |
| Detect Smart Anchors  | boolean         | No       | Automatically place signature fields where the document contains Yousign anchor text.                                                                                                     |
| Signature Page        | integer         | No       | Page where the signature box is placed. Defaults to the last page.                                                                                                                        |
| Signature X Position  | integer         | No       | Horizontal position of the signature box on the page, in points from the left edge.                                                                                                       |
| Signature Y Position  | integer         | No       | Vertical position of the signature box on the page, in points from the top edge.                                                                                                          |
| Expiration Date       | date            | No       | Day the request expires if not signed.                                                                                                                                                    |

#### Outputs

| Field                | Type   | Description                                                                          |
| -------------------- | ------ | ------------------------------------------------------------------------------------ |
| Signature Request ID | string | Identifier of the created signature request.                                         |
| Status               | string | Status after activation, normally "ongoing".                                         |
| Signer ID            | string | Identifier of the signer that was added.                                             |
| Signature Link       | string | Direct signing link for the signer (share it yourself when delivery mode is "none"). |
| Document ID          | string | Identifier of the uploaded document.                                                 |

### Create Signature Request

Create a new draft signature request. Add documents and signers to it, then activate it to send.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                              |
| --------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| Request Name          | string          | Yes      | Name of the signature request, shown to signers.                                                                         |
| Delivery Mode         | select (string) | No       | How signers are invited: by email from Yousign, or not at all (you share links yourself). Available values: Email, None. |
| Show Advanced Options | boolean         | No       | Show sign-in-order, template, workspace, expiration, and other optional settings.                                        |
| Sign in Order         | boolean         | No       | Ask signers to sign one after another, in the order they were added.                                                     |
| Template              | select (string) | No       | Start from a Yousign template instead of an empty request. Options load from the selected connection.                    |
| Workspace             | select (string) | No       | Workspace to create the request in. Defaults to your default workspace. Options load from the selected connection.       |
| Expiration Date       | date            | No       | Day the request expires if not signed.                                                                                   |
| Email Note            | textarea        | No       | Personal note included in the invitation email.                                                                          |
| Allow Decline         | boolean         | No       | Let signers formally decline to sign.                                                                                    |
| External ID           | string          | No       | Your own reference for this request, e.g. a CRM record id.                                                               |
| Timezone              | string          | No       | Timezone used for dates shown to signers.                                                                                |

#### Outputs

| Field                | Type   | Description                                |
| -------------------- | ------ | ------------------------------------------ |
| Signature Request ID | string | Identifier of the new draft request.       |
| Status               | string | Status of the new request, always "draft". |
| Name                 | string | Name of the request.                       |

### Add Document to Signature Request

Upload a document (from a URL) to a draft signature request.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                     |
| --------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Signature Request     | select (string) | Yes      | The draft request to add the document to. Options load from the selected connection.                            |
| Document URL          | string          | Yes      | Link to the file to upload (PDF, DOCX, JPEG, or PNG; images can only be attachments). It is fetched for you.    |
| Document Role         | select (string) | No       | Whether the document is signed or just attached for reference. Available values: Signable Document, Attachment. |
| Show Advanced Options | boolean         | No       | Show the document name override and smart-anchor detection toggle.                                              |
| Document Name         | string          | No       | Optional file name to show instead of the one from the URL.                                                     |
| Detect Smart Anchors  | boolean         | No       | Automatically place signature fields where the document contains Yousign anchor text.                           |

#### Outputs

| Field         | Type    | Description                                       |
| ------------- | ------- | ------------------------------------------------- |
| Document ID   | string  | Identifier of the uploaded document.              |
| File Name     | string  | Stored file name.                                 |
| Total Pages   | integer | Number of pages in the document.                  |
| Anchors Found | integer | Number of smart anchors detected in the document. |

### Add Signer to Signature Request

Add a person who must sign, and place their signature box on a document.

#### Inputs

| Field                      | Type            | Required | Description                                                                                                                                                                               |
| -------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Signature Request          | select (string) | Yes      | The draft request to add the signer to. Options load from the selected connection.                                                                                                        |
| First Name                 | string          | Yes      | Signer's first name.                                                                                                                                                                      |
| Last Name                  | string          | Yes      | Signer's last name.                                                                                                                                                                       |
| Email                      | string          | Yes      | Email address where the invitation is sent.                                                                                                                                               |
| Phone Number               | string          | No       | Signer's mobile number, only needed for SMS code verification.                                                                                                                            |
| Language                   | select (string) | No       | Language used in emails and the signing page for this signer. Available values: English, French, German, Italian, Dutch, Spanish, Polish, Portuguese, Romanian.                           |
| Signature Level            | select (string) | No       | Legal strength of the signature. Simple electronic signature suits most documents. Available values: Electronic Signature, Advanced Electronic Signature, Qualified Electronic Signature. |
| Signer Verification        | select (string) | No       | How the signer proves it is them: a code by email, a code by SMS, or no code. Available values: Code by Email, Code by SMS, No Code.                                                      |
| Document for Signature Box | select (string) | No       | Document the signature box is placed on. Defaults to the first signable document. Options load from the selected connection.                                                              |
| Signature Page             | integer         | No       | Page where the signature box is placed. Defaults to the last page.                                                                                                                        |
| Signature X Position       | integer         | No       | Horizontal position of the signature box, in points from the left edge.                                                                                                                   |
| Signature Y Position       | integer         | No       | Vertical position of the signature box, in points from the top edge.                                                                                                                      |

#### Outputs

| Field          | Type   | Description                                                                                       |
| -------------- | ------ | ------------------------------------------------------------------------------------------------- |
| Signer ID      | string | Identifier of the new signer.                                                                     |
| Signer Status  | string | Signer's current status, "initiated" until activation.                                            |
| Signature Link | string | Direct signing link (available after activation; share it yourself when delivery mode is "none"). |

### Activate Signature Request

Send a draft request out for signature. Signers are notified (unless delivery mode is "none").

#### Inputs

| Field             | Type            | Required | Description                                                               |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------- |
| Signature Request | select (string) | Yes      | The draft request to send out. Options load from the selected connection. |

#### Outputs

| Field                | Type          | Description                                                |
| -------------------- | ------------- | ---------------------------------------------------------- |
| Signature Request ID | string        | Identifier of the activated request.                       |
| Status               | string        | Status after activation, normally "ongoing".               |
| Signers              | object\_array | The request's signers with their status and signing links. |

### Get Signature Request

Check the current status and details of a signature request.

#### Inputs

| Field             | Type            | Required | Description                                                        |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------ |
| Signature Request | select (string) | Yes      | The request to look up. Options load from the selected connection. |

#### Outputs

| Field                | Type          | Description                           |
| -------------------- | ------------- | ------------------------------------- |
| Signature Request ID | string        | Identifier of the request.            |
| Status               | string        | Current status of the request.        |
| Name                 | string        | Name of the request.                  |
| Expiration Date      | string        | When the request expires.             |
| Completed At         | string        | When everyone finished signing.       |
| Signers              | object\_array | Signers with their individual status. |
| Documents            | object\_array | Documents attached to the request.    |

### List Signature Requests

List your signature requests, with optional search and status filter.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                                         |
| --------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| Search                | string          | No       | Search requests by name.                                                                                                            |
| Status                | select (string) | No       | Only show requests in this status. Available values: Draft, Ongoing, Done, Expired, Canceled, Approval, Rejected, Declined, Paused. |
| Show Advanced Options | boolean         | No       | Show external id, workspace, page size, and cursor options.                                                                         |
| External ID           | string          | No       | Find requests by the external reference you set at creation.                                                                        |
| Workspace             | select (string) | No       | Only show requests from this workspace. Options load from the selected connection.                                                  |
| Max Results           | integer         | No       | Maximum number of requests to return. Minimum: 1.                                                                                   |
| Page Cursor           | string          | No       | Continue from a previous page (use the next\_cursor output).                                                                        |

#### Outputs

| Field              | Type          | Description                                                          |
| ------------------ | ------------- | -------------------------------------------------------------------- |
| Signature Requests | object\_array | The matching signature requests.                                     |
| Next Page Cursor   | string        | Cursor to fetch the next page, empty when there are no more results. |

### Cancel Signature Request

Cancel a signature request so it can no longer be signed.

#### Inputs

| Field             | Type            | Required | Description                                                                                                                                           |
| ----------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Signature Request | select (string) | Yes      | The request to cancel. Canceling is permanent: signers are notified and the request cannot be reactivated. Options load from the selected connection. |
| Reason            | select (string) | No       | Why the request is being canceled. Available values: Contract aborted, Errors in document, Other.                                                     |
| Note              | textarea        | No       | Optional note explaining the cancellation.                                                                                                            |

#### Outputs

| Field                | Type   | Description                            |
| -------------------- | ------ | -------------------------------------- |
| Signature Request ID | string | Identifier of the canceled request.    |
| Status               | string | Status after cancellation, "canceled". |

### Send Signer Reminder

Nudge a signer who has not signed yet with a reminder email.

#### Inputs

| Field             | Type            | Required | Description                                                                           |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Signature Request | select (string) | Yes      | The ongoing request the signer belongs to. Options load from the selected connection. |
| Signer            | select (string) | Yes      | The signer to remind. Options load from the selected connection.                      |

#### Outputs

| Field         | Type    | Description                    |
| ------------- | ------- | ------------------------------ |
| Reminder Sent | boolean | Whether the reminder was sent. |

### Download Signed Document

Download the signed document(s) of a completed signature request as a file.

#### Inputs

| Field                 | Type            | Required | Description                                                                                                    |
| --------------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| Signature Request     | select (string) | Yes      | The request whose documents you want. Options load from the selected connection.                               |
| Version               | select (string) | No       | Signed final version, or the documents as they currently stand. Available values: Completed (signed), Current. |
| Show Advanced Options | boolean         | No       | Show single-document and archive options.                                                                      |
| Single Document       | select (string) | No       | Download only this document instead of all of them. Options load from the selected connection.                 |
| Force ZIP Archive     | boolean         | No       | Always package the download as a ZIP file.                                                                     |

#### Outputs

| Field     | Type   | Description                   |
| --------- | ------ | ----------------------------- |
| File Name | string | Name of the downloaded file.  |
| File      | string | The downloaded document file. |

### Download Audit Trail

Download the legal audit trail (proof file) of a completed signature request.

#### Inputs

| Field              | Type            | Required | Description                                                                                  |
| ------------------ | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Signature Request  | select (string) | Yes      | The completed request whose audit trail you want. Options load from the selected connection. |
| Merge Into One PDF | boolean         | No       | Combine all signers' audit trails into a single PDF.                                         |

#### Outputs

| Field     | Type   | Description                  |
| --------- | ------ | ---------------------------- |
| File Name | string | Name of the downloaded file. |
| File      | string | The audit trail file.        |

## Triggers

A trigger starts a workflow when its configured event occurs. Configure the event and filters before enabling the trigger.

### Signature Request Completed

Fires when every signer has signed and the signature request reaches "done".

This webhook registers itself automatically with Yousign; there is nothing to paste anywhere. It fires for a signature request created anywhere: in the Yousign app, the public API, or a connector. The connection's own environment (production or sandbox) decides which requests this trigger watches, not this workflow.

#### Event inputs

| Field                | Type   | Required | Description                                     |
| -------------------- | ------ | -------- | ----------------------------------------------- |
| Signature Request ID | string | Yes      | Identifier of the completed request. Default: . |
| Request Name         | string | No       | Name of the completed request.                  |
| Completed At         | string | No       | When signing finished.                          |

#### Outputs

| Field                | Type   | Description                          |
| -------------------- | ------ | ------------------------------------ |
| Signature Request ID | string | Identifier of the completed request. |
| Request Name         | string | Name of the completed request.       |
| Completed At         | string | When signing finished.               |

### Signer Signed

Fires each time an individual signer completes their signature (other signers may still be pending).

This webhook registers itself automatically with Yousign; there is nothing to paste anywhere. It fires once per signer, as soon as that signer finishes signing, even if other signers on the same request are still pending. The connection's own environment (production or sandbox) decides which requests this trigger watches, not this workflow.

#### Event inputs

| Field                | Type   | Required | Description                                     |
| -------------------- | ------ | -------- | ----------------------------------------------- |
| Signature Request ID | string | Yes      | Request the signer belongs to. Default: .       |
| Signer ID            | string | Yes      | Identifier of the signer who signed. Default: . |
| Signer Email         | string | No       | Email of the signer who signed.                 |

#### Outputs

| Field                | Type   | Description                          |
| -------------------- | ------ | ------------------------------------ |
| Signature Request ID | string | Request the signer belongs to.       |
| Signer ID            | string | Identifier of the signer who signed. |
| Signer Email         | string | Email of the signer who signed.      |

### Signature Request Failed

Fires when a signature request ends without being signed: declined by a signer, canceled, or expired.

This webhook registers itself automatically with Yousign; there is nothing to paste anywhere. It fires for a signature request created anywhere: in the Yousign app, the public API, or a connector, whenever that request is declined by a signer, canceled by its sender, or expires before completion. The connection's own environment (production or sandbox) decides which requests this trigger watches, not this workflow.

#### Event inputs

| Field                | Type   | Required | Description                                               |
| -------------------- | ------ | -------- | --------------------------------------------------------- |
| Signature Request ID | string | Yes      | Identifier of the failed request. Default: .              |
| What Happened        | string | Yes      | Whether it was declined, canceled, or expired. Default: . |
| Request Name         | string | No       | Name of the request.                                      |

#### Outputs

| Field                | Type   | Description                                    |
| -------------------- | ------ | ---------------------------------------------- |
| Signature Request ID | string | Identifier of the failed request.              |
| What Happened        | string | Whether it was declined, canceled, or expired. |
| Request Name         | string | Name of the request.                           |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/yousign.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
