> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atako.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Yousign

> Connect Yousign to your Atako agents — 9 read and 5 write actions.

Let your agents prepare electronic signature requests in Yousign, add signers, activate and cancel them, and follow their signers and documents.

## Connection

* **Authentication**: API key.
* **Required settings**:
  * **Environment** — Use "api-sandbox" for the Sandbox (api-sandbox.yousign.app), or "api" for Production (api.yousign.app).

<Note>
  Sign in at yousign.app → Developers → API keys → pick the Sandbox or Production tab → New API key. Give it a description, select that environment and the Organization scope, then copy the key (it is shown once). Enter "api-sandbox" in the Environment field for a Sandbox key, "api" for a Production key — a key is valid on one environment only. The Sandbox is rate-limited (see Yousign's API documentation for the current limits).

  See [Yousign's documentation](https://developers.yousign.com/reference).
</Note>

## Read actions (9)

| Action                    | Description                                                                                                                                                           |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_signature_request`   | Fetch a single signature request: status, delivery mode, dates, signers, approvers and documents.                                                                     |
| `get_signer`              | Fetch a single signer of a signature request.                                                                                                                         |
| `list_custom_experiences` | List the custom experiences (signature journey branding), to obtain the custom\_experience\_id used by create\_signature\_request.                                    |
| `list_documents`          | List the documents of a signature request. Optional filter: nature ("signable\_document" or "attachment").                                                            |
| `list_signature_requests` | List signature requests, newest first. Optional filters: status, workspace\_id, external\_id, q (free-text search on the name). Cursor pagination with limit + after. |
| `list_signers`            | List the signers of a signature request with their status, signature level and authentication mode.                                                                   |
| `list_templates`          | List the signature request templates, to obtain the template\_id used by create\_signature\_request.                                                                  |
| `list_users`              | List the users of the organization. Optional filter: email. Cursor pagination with limit + after.                                                                     |
| `list_workspaces`         | List the workspaces of the organization. Cursor pagination with limit + after.                                                                                        |

## Write actions (5)

| Action                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `activate_signature_request` | Activate a draft signature request: it moves to "ongoing" and signers are notified according to its delivery mode. Arguments: signatureRequestId (UUID string, in the path), sender\_id (UUID string of an active user of the request's workspace, optional — only when the request's e-mail sender type is "user").                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `add_signer`                 | Add a signer to a draft signature request. Arguments: signatureRequestId (UUID string, in the path), info (object \{first\_name: string, last\_name: string, email: string, locale: string enum en\|fr\|de\|it\|nl\|es\|pl\|pt\|ro — all four required; phone\_number: string in E.164 such as "+33612345678", optional}), signature\_level (string enum: "electronic\_signature" \| "advanced\_electronic\_signature" \| "qualified\_electronic\_signature"), signature\_authentication\_mode (string enum: "otp\_email" \| "otp\_sms" \| "no\_otp", optional), delivery\_mode (string enum: "email" \| "none", optional, overrides the request's), fields (array of objects, optional — signature field \{document\_id: UUID string, type: "signature", page: integer ≥ 1, x: integer, y: integer, width?: integer ≥ 85, height?: integer ≥ 37, reason?: string} or mention field \{document\_id, type: "mention", page, x, y, mention: string, width?, height?, name?}), redirect\_urls (object \{success?: string URL, error?: string URL, decline?: string URL}, optional), insert\_after\_id (UUID string of the recipient this one must follow when ordered\_signers is enabled, optional). |
| `cancel_signature_request`   | Cancel an ongoing signature request. Arguments: signatureRequestId (UUID string, in the path), reason (string enum, required: "contractualization\_aborted" \| "errors\_in\_document" \| "other"), custom\_note (string, max 500, Safe String, optional).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `create_signature_request`   | Create a signature request in draft status. Arguments: name (string, 1–128, Safe String: no leading/trailing space, no HTML tag, no URL, no e-mail), delivery\_mode (string enum: "email" \| "none"), template\_id (UUID string, optional), timezone (tz database string, e.g. "Europe/Paris", optional), expiration\_date (string "yyyy-mm-dd", optional), ordered\_signers (boolean, optional), signers\_allowed\_to\_decline (boolean, optional), reminder\_settings (object \{interval\_in\_days: integer 1\|2\|7\|14, max\_occurrences: integer 1–10}, both required when present, optional), audit\_trail\_locale (string enum: de\|en\|es\|fr\|it\|pt\|ro, optional), custom\_experience\_id (UUID string, optional), workspace\_id (UUID string, optional), external\_id (string, max 255, characters \[A-Za-z0-9\_-\@.%+], optional). Documents and signers are added afterwards, then activate\_signature\_request sends it.                                                                                                                                                                                                                                                             |
| `send_reminder`              | Send a manual reminder e-mail to one signer of an ongoing signature request. Arguments: signatureRequestId (UUID string, in the path), signerId (UUID string, in the path).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

## Permissions

Every action above must be explicitly granted to an agent before it can be used. See [Permissions](/integrations/permissions) for the grant model and [Security](/integrations/security) for how credentials are protected.
