# Lacuna Software documentation: Signer

> Lacuna Signer is a document and signature manager that collects digital and electronic signatures, as SaaS or as an on-premises instance.

Every link below points at a page's Markdown version: the page URL plus ".md". The quick reference, when the
product has one, comes first: install, configuration, core operations, errors and samples on one page.

These 73 pages, concatenated (681 KB), in 2 parts of at most 400 KB, so that each fits in one fetch:
- [Part 1](https://docs.lacunasoftware.com/en-us/articles/signer/llms-full-1.txt) (343 KB): pages 1–44, "Signer quick reference" to "Rolling back a Signer version"
- [Part 2](https://docs.lacunasoftware.com/en-us/articles/signer/llms-full-2.txt) (338 KB): pages 45–73, "Getting started with the Signer API" to "Signer"

Index of all products: https://docs.lacunasoftware.com/llms.txt

## Pages

- [Signer quick reference](https://docs.lacunasoftware.com/en-us/articles/signer/quick-reference.md): Lacuna Signer on one page: API key, base URLs, client packages, document creation, signing URL, status, download, webhooks and errors.
- [Lacuna Signer](https://docs.lacunasoftware.com/en-us/articles/signer.md): Lacuna Signer is a document and signature manager that collects digital and electronic signatures, as SaaS or as an on-premises instance.
- [Signer *on-premises*](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises.md): Signer as SaaS or on your own infrastructure (on premises), with the supported environments: Windows Server, Linux, Docker and Azure App Services.
- [Signer - Setup on Windows Server](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/windows.md): How to install an on-premises instance of Signer on Windows Server with IIS: binaries package, prerequisites, database requirements and installation steps.
- [Updating Signer on Windows Server](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/windows/update.md): How to update Signer on Windows Server with IIS: check the installed version, back up, replace the site binaries, confirm the new version and know how to roll back.
- [Signer - Setup on Linux](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/linux.md): Setup of Signer on Linux: the supported distribution (Ubuntu Server), with links to the update guide and troubleshooting.
- [Troubleshooting issues on your Signer instance (Linux)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/linux/troubleshoot.md): Troubleshooting a Signer instance on Linux: documentation still under construction, pointing to checking the system logs.
- [Signer - Checking the system logs (Linux)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/linux/troubleshoot/check-logs.md): How to read Signer logs on Linux with journalctl for the lacuna-signer service, including continuous monitoring and recent entries only.
- [Installing Signer on Ubuntu Server](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/linux/install-ubuntu.md): How to install an on-premises Signer on Ubuntu Server: prerequisites (PKI SDK and Web PKI licenses, DNS, SQL Server) and the ASP.NET Core Runtime 10.0.
- [Updating Signer on Linux](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/linux/update.md): How to update Signer on Linux: check the installed version, back up, replace the lacuna-signer service binaries, confirm the new version and know how to roll back.
- [Signer - Setup on Azure App Services](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/azure.md): Installing an on-premises Signer on Azure App Services: the binaries package and creating the SQL database, the storage account and the App Service.
- [Updating Signer on Azure App Services](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/azure/update.md): How to update Signer on Azure App Services: check the installed version, back up the database, publish the new package through Kudu, confirm the new version and know how to roll back.
- [Signer - Setup on Docker](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/docker.md): Setup of Signer on Docker with the lacunasoftware/signer image: SQL Server database, shared storage and OIDC server (GrantID), via env variables.
- [Updating Signer on Docker](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/docker/update.md): How to update Signer on Docker and Docker Swarm: check the installed version, back up, change the lacunasoftware/signer image tag, confirm the new version and know how to roll back.
- [Preparing a database for installation of Signer](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/prepare-database.md): How to prepare the SQL Server database for an on-premises Signer: required collation, db_owner credentials and the T-SQL to create it.
- [Serilog Configuration](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/serilog.md): Serilog settings of Signer: how to direct logs to one or more sinks, such as File and Azure Table Storage, with configuration examples.
- [Blob Storage Configuration](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/blob-storage.md): BlobStorage settings of Signer: storing files in the file system or in an Azure Storage Account container, with configuration examples for each.
- [Upload size limit](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/limite-de-upload.md): Every layer that limits the upload size on an on-premises Signer: MaxFileSize, MaxUploadSizeInBytes, IIS, Kestrel and Nginx, and how document versions affect storage.
- [Signer Access Control](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/access-control.md): Signer user access control: an open system, where any user can sign up, and a closed system, where an administrator grants access.
- [Signer Pix Authentication](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/pix-authentication.md): Pix authentication in Signer: an electronic signature in which the user authenticates with a Pix payment, using QR codes generated by the Gerencianet APIs.
- [Signer Zoom Integration](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/zoom.md): Signer integration with Zoom to hold and store video conferences about documents, with the account requirements and Zoom users acting as rooms.
- [Signer Payments](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/payments.md): Options for collecting payment of the invoices generated by the Signer Billing System, in which the administrator chooses which services are charged.
- [iugu payment gateway](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/iugu.md): Signer integration with the iugu payment gateway, so invoices can be paid by credit card, boleto bancário or Pix, since version 1.27.0.
- [Electronic Service Invoice (NFS-e)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/nfse.md): Signer integration with NFE.io to issue and cancel NFS-e (Brazilian electronic service invoices) for paid invoices, with the first registration and setup steps.
- [Whatsapp](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/whatsapp.md): Signer integration with Meta's Whatsapp Business API to send notifications via Whatsapp (since 1.56.0), with the prerequisites and account setup.
- [SMS sending](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/sms.md): How to configure SMS sending in Signer for electronic signatures with a code via SMS: the SMS settings and credentials of providers such as Twilio.
- [E-mail server (SMTP)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/email-smtp.md): How to configure Signer e-mail sending in the Email settings: SMTP through MailKit by default, with Amazon SES and SendGrid also supported.
- [Cloud certificate](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/certificado-em-nuvem.md): How to enable cloud certificates on an on-premises Signer: registering the app with the provider (PSC or CSC), redirect URI, ClientId and ClientSecret, discovery and common errors.
- [Templates (Microsoft Graph)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/modelos.md): How to enable the Templates feature on an on-premises Signer: DOCX to PDF conversion through Microsoft Graph and SharePoint, the prerequisites and the four settings of the Graph section.
- [Fix notification sending failures](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/notificacoes-nao-enviadas.md): How to test Signer notification sending by e-mail, SMS and Whatsapp, where failures show (log and Hangfire) and how to fix the failures of each channel.
- [Signer Settings](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/settings.md): Reference of Signer settings for on-premises instances, starting with the General section: SiteUrl, EncryptionKey, AutoUpdateDatabase, SupportEmailAddress.
- [Signer customization](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization.md): Overview of Signer customization at instance and organization level: what can be customized, who configures it and where each setting is documented.
- [Visual identity](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization/identidade-visual.md): Visual identity of a Signer instance: the color theme, chosen by a three-letter code, and the four logo files served under /theme-assets/.
- [Available themes](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization/temas.md): List of available Signer themes, each with a three-letter code used to change the instance theme and in the Embedded Signature widget.
- [Home page and footer](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization/home-e-footer.md): How to customize the Signer home page and footer: simple configuration of the highlight area, or advanced configuration with a static page replacing it.
- [E-mails and notifications](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization/emails.md): How to customize Signer e-mails: logo and colors per organization, set by its administrator, and text overrides in any language, set by the system admin.
- [Generated documents](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization/documentos.md): Customizing the files Signer generates, per organization: the printer friendly version, the validation stamp and the signature visual representation.
- [Own domain](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/customization/dominio.md): How to serve a Signer instance under your own domain: add a CNAME DNS record and notify the deployment team to adjust the certificate and site.
- [TrustArbitrator](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/trust-arbitrator.md): The Signer TrustArbitrator, which defines the certificates and root CAs Signer accepts, ICP-Brasil by default, and how to accept your own root CA.
- [Updating Signer from 1.x to 2.x](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/update-20.md): Extra steps to update an on-premises Signer from 1.x to 2.x, such as installing the ASP.NET Core Runtime 8.0 and setting an explicit AppDiscriminator.
- [Updating Signer from 2.x to 3.x](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/update-30.md): Extra steps to update an on-premises Signer from 2.x to 3.x, such as installing the ASP.NET Core Runtime 10.0 and following the database migrations.
- [DocumentUsers index (version 2.21.0)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/documentusers-index.md): How Signer fills the denormalized columns and builds the DocumentUsers table index when updating from a version earlier than 2.21.0 to 2.21.0 or later (including 3.x), and what to do if the automatic process fails.
- [Documents index (documents reports)](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/update-30-documents-index.md): How Signer builds the Documents table index used by the documents reports when updating to 3.0.0, and what to do if the automatic process fails.
- [Rolling back a Signer version](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/rollback.md): How to roll an on-premises Signer back to a previous version: restore the binaries and, if the update applied migrations, revert the SQL Server database with the update-db command.
- [Getting started with the Signer API](https://docs.lacunasoftware.com/en-us/articles/signer/get-started.md): Getting started with the Signer API: from zero to your first signed document in six steps, creating a document, collecting a signature and downloading it.
- [Administration APIs](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/administration.md): Signer administration APIs to create and manage users and organizations, and how to create the administration API key in the Sys Admin organization.
- [Consumption Monitoring](https://docs.lacunasoftware.com/en-us/articles/signer/on-premises/consumption-monitoring.md): Signer consumption monitoring APIs, with information and reports on user operations, and how to create the API key with the Monitor role.
- [Integration Guide](https://docs.lacunasoftware.com/en-us/articles/signer/integration-guide.md): Signer Integration Guide: API key authentication and the integration options for your application to use Signer, as a reference for each use case.
- [Create documents](https://docs.lacunasoftware.com/en-us/articles/signer/integration/documents.md): How to create a document in Signer through the API: upload the file, then create the document by defining the participant flow.
- [Document field reference](https://docs.lacunasoftware.com/en-us/articles/signer/integration/document-fields.md): Reference of the Signer POST /api/documents fields: participant data, identifier types, participant options and document options.
- [Track documents](https://docs.lacunasoftware.com/en-us/articles/signer/integration/tracking.md): How to track Signer documents by polling their status or receiving webhook notifications, and how to remind participants who have not acted yet.
- [Download and list documents](https://docs.lacunasoftware.com/en-us/articles/signer/integration/download-and-list.md): How to download the versions of a Signer document, such as the original, the signed file and the printer friendly version, and how to list documents.
- [Validate document's signatures](https://docs.lacunasoftware.com/en-us/articles/signer/integration/validation.md): How to validate a document's signatures in Signer with its validation key or with the signed file, which also works for documents signed elsewhere.
- [Document lifecycle](https://docs.lacunasoftware.com/en-us/articles/signer/integration/lifecycle.md): Operations in the Signer document lifecycle through the API: cancel, refuse, pause and resume, submit a new version, delete and restore a document.
- [Sign documents in a batch](https://docs.lacunasoftware.com/en-us/articles/signer/integration/batch-signing.md): How to sign several Signer documents with the user's certificate in one go from your own application: Signer's public signature calls, run once per document, with Web PKI signing every hash after a single confirmation.
- [Contacts and identifiers](https://docs.lacunasoftware.com/en-us/articles/signer/integration/contacts.md): How to manage the organization's contacts through the Signer API, including in a batch from a CSV file, and a user's identifiers (CPF, passport and others).
- [Embedded signatures integration](https://docs.lacunasoftware.com/en-us/articles/signer/embedded-signature.md): How to embed Signer signing and approval in any application with the LacunaSignerWidget component, which needs a Web PKI license for the page domain.
- [Webhooks](https://docs.lacunasoftware.com/en-us/articles/signer/webhooks.md): Signer webhooks: Signer sends a POST to a URL of your application when a document is created, signed, approved, refused, concluded, canceled, paused, resumed, expired or deleted.
- [Event reference](https://docs.lacunasoftware.com/en-us/articles/signer/webhook-events.md): Signer webhook event reference: body format, the fields of each event, field types and a sample of every event.
- [Participant identification](https://docs.lacunasoftware.com/en-us/articles/signer/concepts/participant-identification.md): How Signer identifies a person by CPF and e-mail, how it links a participant to an existing user, the uniqueness rules, foreign signers and single sign-on (SSO).
- [Signature types](https://docs.lacunasoftware.com/en-us/articles/signer/concepts/signature-types.md): Signer's Simple, Advanced and Qualified signature types: what each produces, when the ITI validator accepts it, the API default and what happens to a PDF that arrives already signed.
- [Notifications](https://docs.lacunasoftware.com/en-us/articles/signer/concepts/notifications.md): Who Signer notifies at each document event, the notification language, reminders, and the screen, API and instance options that turn each notification off.
- [Privacy](https://docs.lacunasoftware.com/en-us/articles/signer/concepts/privacy.md): Signer privacy options: masking signers' CPF, collecting geolocation on electronic signatures and document access validation. All of them apply to the whole instance.
- [Lacuna Signer - User Guide](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide.md): Lacuna Signer user guide, still under construction, with links to document generation and system administration.
- [Lacuna Signer - Document generation](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/gen-docs.md): How to generate PDF documents in Signer from a template: a PDF with editable form fields, created for example in PhantomPDF.
- [Managing an organization](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/admin-organizacao.md): Guide for the administrator of a Signer organization: adding and removing users, what happens when an employee leaves, the last administrator and changing plans.
- [Access profiles](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/perfis-de-acesso.md): Reference of the access profiles of a Signer organization (Basic, Operator, Manager and Administrator): what each profile can do and the instance settings that change those permissions.
- [Fixing participant registration errors](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/erros-de-cadastro.md): How to fix the most common errors when registering participants in Signer: EmailAlreadyBeingUsed, CpfAlreadyBeingUsed, DuplicateUser, a signature with someone else's name and the same e-mail for different people.
- [System administration - Lacuna Signer](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/sys-admin.md): System administration in Lacuna Signer, still under construction, with links to adding users and browsing the system's documents.
- [Adding a user to system administration](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/sys-admin/add-user.md): How to add a user with the System Administrator role in Signer, by inviting them to the sys admin organization from the Administration page.
- [Browsing the system's documents](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/sys-admin/browse-docs.md): How the system administrator views the documents each user submitted in Signer, from Administration, under Organizations and Personal Accounts.
- [Deleting documents](https://docs.lacunasoftware.com/en-us/articles/signer/user-guide/sys-admin/del-docs.md): How to delete documents in Signer: check the document in the Documents list, select the trash can and confirm the deletion.
- [Signer](https://docs.lacunasoftware.com/en-us/articles/signer/changelog.md): Release history of Signer: versions with new features, improvements and bug fixes, download links and whether each one updates the database model.

## API specifications

- [Signer API](https://docs.lacunasoftware.com/openapi/signer.json): OpenAPI 3.0.1 copy of the Signer API spec of the cloud service (version 2.16.1); live spec: https://www.dropsigner.com/swagger/api/swagger.json

## Optional

- [Signer: documentação em português](https://docs.lacunasoftware.com/articles/signer/llms.txt): the same index for the Portuguese (pt-BR) pages