mirror of
https://github.com/documenso/documenso.git
synced 2025-11-16 01:32:06 +10:00
8367878395
## Description <!--- Describe the changes introduced by this pull request. --> <!--- Explain what problem it solves or what feature/fix it adds. --> ## Related Issue <!--- If this pull request is related to a specific issue, reference it here using #issue_number. --> <!--- For example, "Fixes #123" or "Addresses #456". --> ## Changes Made <!--- Provide a summary of the changes made in this pull request. --> <!--- Include any relevant technical details or architecture changes. --> - Change 1 - Change 2 - ... ## Testing Performed <!--- Describe the testing that you have performed to validate these changes. --> <!--- Include information about test cases, testing environments, and results. --> - Tested feature X in scenario Y. - Ran unit tests for component Z. - Tested on browsers A, B, and C. - ... ## Checklist <!--- Please check the boxes that apply to this pull request. --> <!--- You can add or remove items as needed. --> - [ ] I have tested these changes locally and they work as expected. - [ ] I have added/updated tests that prove the effectiveness of these changes. - [ ] I have updated the documentation to reflect these changes, if applicable. - [ ] I have followed the project's coding style guidelines. - [ ] I have addressed the code review feedback from the previous submission, if applicable. ## Additional Notes <!--- Provide any additional context or notes for the reviewers. --> <!--- This might include details about design decisions, potential concerns, or anything else relevant. --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Enhanced project README for clarity and improved environment variables section. - Added comprehensive developer and user documentation, including guides on local development, public API, self-hosting, and compliance standards. - Introduced specific guides for contributing, creating API keys, using webhooks, and setting up security measures. - Detailed documentation on various fields available for document signing to improve user understanding. - Added metadata structuring to improve navigation within the documentation site. - **Chores** - Updated `.gitignore` to better handle project files. - **New Features** - Introduced detailed metadata and documentation for various Documenso functionalities, including signing documents, user profiles, and compliance levels. - Added functionality for Direct Link Signing, enabling easy sharing for document signing. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Timur Ercan <timur.ercan31@gmail.com> Co-authored-by: Lucas Smith <me@lucasjamessmith.me> Co-authored-by: David Nguyen <davidngu28@gmail.com>
153 lines
7.2 KiB
Plaintext
153 lines
7.2 KiB
Plaintext
---
|
|
title: Send a document for signing
|
|
description: The guide gives a detailed description of all options available when sending out a document for signing.
|
|
---
|
|
|
|
import { Callout, Steps } from 'nextra/components';
|
|
|
|
# Send Documents for Signing
|
|
|
|
This guide will walk you through the process of sending a document out for signing. You will learn how to upload a document, add recipients, place signature fields, and send the document for signing.
|
|
|
|
<Steps>
|
|
### Login Into Your Account
|
|
|
|
The guide assumes you have a Documenso account. If you don't, you can create a free account [here](https://documen.so/free-docs).
|
|
|
|
### Upload Document
|
|
|
|
Navigate to the [Documenso dashboard](https://app.documenso.com/documents) and click on the "Add a document" button. Select the document you want to upload and wait for the upload to complete.
|
|
|
|
|
|
|
|
After the upload is complete, you will be redirected to the document's page. You can configure the document's settings and add recipients and fields here.
|
|
|
|
|
|
|
|
### (Optional) Advanced Options
|
|
|
|
Click on the "Advanced options" button to access additional settings for the document. You can set an external ID, date format, time zone, and the redirect URL.
|
|
|
|
|
|
|
|
The external ID allows you to set a custom ID for the document that can be used to identify the document in your external system(s).
|
|
|
|
The date format and time zone settings allow you to customize how the date and time are displayed in the document.
|
|
|
|
The redirect URL allows you to specify a URL where the signer will be redirected after signing the document.
|
|
|
|
### (Optional) Document Access
|
|
|
|
Documenso enables you to set up access control for your documents. You can require authentication for viewing the document.
|
|
|
|
The available options are:
|
|
|
|
- **Require account** - The recipient must be signed in to view the document.
|
|
- **None** - The document can be accessed directly by the URL sent to the recipient.
|
|
|
|
|
|
|
|
<Callout type="info">
|
|
The "Document Access" feature is only available for Enterprise accounts.
|
|
</Callout>
|
|
|
|
### (Optional) Recipient Authentication
|
|
|
|
The "Recipient Authentication" feature allows you to specify the authentication method required for recipients to sign the signature field.
|
|
|
|
The available options are:
|
|
|
|
- **Require passkey** - The recipient must have an account and passkey configured via their settings.
|
|
- **Require 2FA** - The recipient must have an account and 2FA enabled via their settings.
|
|
- **None** - No authentication required.
|
|
|
|
|
|
|
|
This can be overridden by setting the authentication requirements directly for each recipient in the next step.
|
|
|
|
<Callout type="info">
|
|
The "Recipient Authentication" feature is only available for Enterprise accounts.
|
|
</Callout>
|
|
|
|
### Recipients
|
|
|
|
Click the "+ Add Signer" button to add a new recipient. You can configure the recipient's email address, name, role, and authentication method on this page.
|
|
|
|
You can choose any option from the ["Recipient Authentication"](#optional-recipient-authentication) section, or you can set it to "Inherit authentication method" to use the global action signing authentication method configured in the "General Settings" step.
|
|
|
|
|
|
|
|
You can also set the recipient's role, which determines their actions and permissions in the document.
|
|
|
|
|
|
|
|
#### Roles
|
|
|
|
Documenso has 4 roles for recipients with different permissions and actions.
|
|
|
|
| Role | Function | Action required | Signature |
|
|
| :------: | :-----------------------------------------------------------------------------: | :-------------: | :-------: |
|
|
| Signer | Needs to sign signatures fields assigned to them. | Yes | Yes |
|
|
| Approver | Needs to approve the document as a whole. Signature optional. | Yes | Optional |
|
|
| Viewer | Needs to confirm they viewed the document. | Yes | No |
|
|
| BCC | Receives a copy of the signed document after completion. No action is required. | No | No |
|
|
|
|
### Fields
|
|
|
|
Documenso supports 9 different field types that can be added to the document. Each field type collects various information from the recipients when they sign the document.
|
|
|
|
|
|
|
|
The available field types are:
|
|
|
|
- **Signature** - Collects the signer's signature
|
|
- **Email** - Collects the signer's email address
|
|
- **Name** - Collects the signer's name
|
|
- **Date** - Collects the date of the signature
|
|
- **Text** - Collects text input from the signer
|
|
- **Number** - Collects a number input from the signer
|
|
- **Radio** - Collects a single choice from the signer
|
|
- **Checkbox** - Collects multiple choices from the signer
|
|
- **Dropdown/Select** - Collects a single choice from a list of choices
|
|
|
|
All fields can be placed anywhere on the document and resized as needed.
|
|
|
|
<Callout type="info">
|
|
Learn more about the available field types and how to use them on the [Fields
|
|
page](signing-documents/fields).
|
|
</Callout>
|
|
|
|
#### Signature Required
|
|
|
|
Signer Roles require at least 1 signature field. You will get an error message if you try to send a document without a signature field.
|
|
|
|
|
|
|
|
### Email Settings
|
|
|
|
Before sending the document, you can configure the email settings and customize the subject line, message, and sender name.
|
|
|
|
|
|
|
|
If you leave the email subject and message empty, Documenso will use the default email template.
|
|
|
|
### Sending the Document
|
|
|
|
After configuring the document, click the "Send" button to send the document to the recipients. The recipients will receive an email with a link to sign the document.
|
|
|
|
|
|
|
|
#### Signing Link
|
|
|
|
If you need to copy the signing link for each recipient, you can do so by clicking on the recipient whose link you want to copy. The signing link is copied automatically to your clipboard.
|
|
|
|
|
|
|
|
The signing link has the following format:
|
|
|
|
```bash
|
|
https://app.documenso.com/sign/12ACP777zxQLO52hjj_vCB
|
|
```
|
|
|
|
</Steps>
|