# Inkit Documentation

## Guides
- [Adding a role](https://docs.inkit.com/docs/adding-a-role.md)
- [Adding a user](https://docs.inkit.com/docs/adding-a-user.md)
- [Assigning roles to a user](https://docs.inkit.com/docs/assigning-a-role-to-a-user.md)
- [Editing a role](https://docs.inkit.com/docs/editing-a-role.md)
- [Editing a user](https://docs.inkit.com/docs/editing-a-user.md)
- [Managing users and roles](https://docs.inkit.com/docs/managing-users-and-roles.md)
- [Inkit permissions](https://docs.inkit.com/docs/permissions-in-inkit.md)
- [Adding two-factor authentication](https://docs.inkit.com/docs/adding-two-factor-authentication.md)
- [Performing administrative tasks](https://docs.inkit.com/docs/performing-administrative-tasks.md)
- [Using audit logs](https://docs.inkit.com/docs/using-audit-logs.md)
- [Adding, editing and removing folders](https://docs.inkit.com/docs/adding-editing-and-removing-folders.md)
- [Using folders](https://docs.inkit.com/docs/using-folders.md)
- [Sharing folders](https://docs.inkit.com/docs/sharing-folders.md)
- [Specifying folders when generating documents](https://docs.inkit.com/docs/specifying-folders-when-generating-documents.md)
- [Traversing folders](https://docs.inkit.com/docs/traversing-folders.md)
- [Adding a Generate Document button in Salesforce](https://docs.inkit.com/docs/add-a-generate-document-button-on-your-salesforce-page-layout.md)
- [Adding an Inkit Document Viewer in Salesforce](https://docs.inkit.com/docs/add-an-inkit-document-viewer-on-your-salesforce-lighting-record-page.md)
- [Generating documents from Salesforce Apex triggers](https://docs.inkit.com/docs/generating-documents-from-salesforce-apex.md)
- [Generating documents from Salesforce flows](https://docs.inkit.com/docs/generating-documents-from-salesforce-flows.md)
- [Setting up the Inkit app in Salesforce](https://docs.inkit.com/docs/insert-your-api-key-into-the-salesforce-app.md)
- [Installing the Inkit package in Salesforce](https://docs.inkit.com/docs/install-the-salesforce-package.md)
- [Setting up the Salesforce app in Inkit](https://docs.inkit.com/docs/installing-the-salesforce-app.md)
- [Embedding DocuSign fields into a PDF template](https://docs.inkit.com/docs/adding-docusign-esignature-fields-to-a-pdf-template.md)
- [Embedding DocuSign fields into a DOCX template](https://docs.inkit.com/docs/adding-docusign-fields-to-a-docx-template.md)
- [Embedding DocuSign fields into an HTML template](https://docs.inkit.com/docs/adding-docusign-fields-to-an-html-template.md)
- [Setting up the DocuSign app](https://docs.inkit.com/docs/installing-the-docusign-app.md)
- [Setting up the Amazon S3 app](https://docs.inkit.com/docs/setting-up-the-amazon-s3-app.md)
- [Setting up the Box app](https://docs.inkit.com/docs/setting-up-the-box-app.md)
- [Setting up the Dropbox app](https://docs.inkit.com/docs/setting-up-the-dropbox-app.md)
- [Setting up the Google Drive app](https://docs.inkit.com/docs/setting-up-the-google-drive-app.md)
- [Configuring the Magic Link Portal](https://docs.inkit.com/docs/configuring-magic-links.md)
- [Generating documents with Magic Links and sharing them](https://docs.inkit.com/docs/displaying-generated-documents-through-magic-links.md)
- [Setting up the Magic Link app](https://docs.inkit.com/docs/installing-the-magic-link-app.md)
- [Sharing documents with Magic Links](https://docs.inkit.com/docs/sharing-documents-with-magic-links.md)
- [Viewing the status of Magic Links](https://docs.inkit.com/docs/viewing-the-status-of-magic-links.md)
- [Creating a Sepire mail peice](https://docs.inkit.com/docs/creating-a-sepire-mail-peices.md)
- [Setting up the Sepire app](https://docs.inkit.com/docs/installing-the-sepire-app.md)
- [Viewing the status of a Sepire mail piece](https://docs.inkit.com/docs/viewing-the-status-of-a-sepire-mail-piece.md)
- [Accessing the Certificate of Completion](https://docs.inkit.com/docs/accessing-the-certificate-of-completion.md): After a document has been signed, you can download a certificate of completion for your records.
- [Canceling a signature](https://docs.inkit.com/docs/canceling-a-signature.md): Stop a signature request if it was sent in error or is no longer needed.
- [Adding Digital Signature blocks to a DOCX template](https://docs.inkit.com/docs/embedding-digital-signature-fields-in-a-docx-template.md)
- [Adding Digital Signature blocks to a PDF template](https://docs.inkit.com/docs/embedding-digital-signature-fields-in-a-pdf-template.md)
- [Adding Digital Signature blocks to an HTML template](https://docs.inkit.com/docs/embedding-digital-signature-fields-in-an-html-template.md)
- [Digital Signature](https://docs.inkit.com/docs/digital-signatures.md)
- [Reassigning a signer](https://docs.inkit.com/docs/reassign-a-signature.md): Change the assigned signer if the original recipient is unavailable or entered incorrectly.
- [Sending a document for Digital Signature](https://docs.inkit.com/docs/sending-a-document-for-digital-signature.md): Choose whether to upload a document or use a reusable template, then send it for signature.
- [Sending reminders to signers](https://docs.inkit.com/docs/sending-reminders.md): Gently remind recipients to sign their documents if they haven’t already.
- [Signing a Digital Signature document](https://docs.inkit.com/docs/signing-a-digital-signature-document.md)
- [Using Signing Groups for flexible signing](https://docs.inkit.com/docs/signing-groups.md): Signing Groups allow you to request a signature from a predefined group of recipients. Any one member of the group can sign the document on behalf of the group.
- [Using the Digital Signature Dashboard](https://docs.inkit.com/docs/using-the-digital-dignature-dashboard.md)
- [Understanding Digital Signature statuses](https://docs.inkit.com/docs/using-the-digital-signature-statuses.md)
- [Displaying documents](https://docs.inkit.com/docs/displaying-generated-documents.md)
- [Setting Digital Signature as a document destination](https://docs.inkit.com/docs/adding-digital-signature-as-a-document-destination.md)
- [Generating documents using the web app](https://docs.inkit.com/docs/generating-documents-in-the-inkit-web-app.md)
- [Generating documents that expire](https://docs.inkit.com/docs/generating-documents-that-expire.md)
- [Generating documents using the API](https://docs.inkit.com/docs/generating-documents-using-the-inkit-api.md)
- [Generating documents using the web app (Government)](https://docs.inkit.com/docs/generating-documents-using-the-web-app-gov.md)
- [Adding, editing and removing API keys](https://docs.inkit.com/docs/adding-and-removing-api-keys.md)
- [Regenerating API keys](https://docs.inkit.com/docs/generating-api-keys.md)
- [Specifying API keys in your applications](https://docs.inkit.com/docs/specifying-api-keys-in-your-applications.md)
- [Storing API keys](https://docs.inkit.com/docs/storing-api-keys.md)
- [Adding, editing and removing webhooks](https://docs.inkit.com/docs/adding-editing-and-removing-webhooks.md)
- [Processing webhooks on your server](https://docs.inkit.com/docs/connecting-webhooks.md)
- [Using webhooks](https://docs.inkit.com/docs/managing-webhooks.md)
- [Inkit webhook events](https://docs.inkit.com/docs/inkit-webhook-events.md)
- [Storing webhook secret keys](https://docs.inkit.com/docs/storing-webhook-secret-keys.md)
- [API endpoints](https://docs.inkit.com/docs/api-endpoints.md)
- [Standard API request and response objects](https://docs.inkit.com/docs/api-request-objects.md)
- [Create Template](https://docs.inkit.com/docs/create-template.md): _Creates a document template_
- [Send Digital Signature](https://docs.inkit.com/docs/digital_signature.md)
- [List Workflow Statuses](https://docs.inkit.com/docs/flow-statuses.md): _Lists workflows invoked and their statuses_
- [Generate Document](https://docs.inkit.com/docs/generate-document.md): _Generates a document from a template and a set of merge parameters and stores it in a destination_
- [Launch Workflow Batch](https://docs.inkit.com/docs/generate-flow-batch.md): _Launches a set of workflows_
- [Launch Workflow](https://docs.inkit.com/docs/launch-flow.md): _Launches a workflow and generates a document to a set of destinations_
- [List Workflow Batches](https://docs.inkit.com/docs/list-flow-batches.md): _Lists workflow batches created_
- [List Folders](https://docs.inkit.com/docs/list-folders.md): _Lists private folders in Inkit Storage_
- [List Templates](https://docs.inkit.com/docs/list-templates.md): _Lists document templates_
- [Making API requests](https://docs.inkit.com/docs/making-api-requests.md)
- [Paging through list requests](https://docs.inkit.com/docs/paginating-list-requests.md)
- [Retrieve Workflow Batch Information](https://docs.inkit.com/docs/retrieve-flow-batch-information.md): _Retrieves information about a batch of workflows_
- [Retrieve Mail Piece Status](https://docs.inkit.com/docs/retrieve-mail-pieces-status.md): _Retrieves information about the delivery status of a Sepire mail piece_
- [Retrieve Template Information](https://docs.inkit.com/docs/retrieve-template.md): _Retrieves information about a document template_
- [Features](https://docs.inkit.com/docs/about-inkit.md)
- [Quickstart: Generating your first document](https://docs.inkit.com/docs/generating-your-first-document.md)
- [Signing up with Inkit for Government](https://docs.inkit.com/docs/signing-up-with-inkit-for-dod.md)
- [Signing up with Inkit for Commercial](https://docs.inkit.com/docs/user-signup-options.md)
- [Welcome to Inkit](https://docs.inkit.com/docs/welcome-to-inkit.md)
- [Creating and editing templates](https://docs.inkit.com/docs/creating-and-editing-templates.md)
- [Embedding basic conditional statements into a DOCX template](https://docs.inkit.com/docs/adding-basic-conditional-statements-to-a-docx-template.md)
- [Embedding merge fields into a DOCX template](https://docs.inkit.com/docs/adding-merge-fields-to-a-docx-template.md)
- [Building a full-featured DOCX template](https://docs.inkit.com/docs/building-a-full-featured-docx-template.md)
- [Creating DOCX templates](https://docs.inkit.com/docs/creating-docx-templates.md)
- [Iterating through a list or a table in a DOCX template](https://docs.inkit.com/docs/iterating-through-a-list-or-a-table-in-a-docx-template.md)
- [Embedding basic conditional statements into an HTML template](https://docs.inkit.com/docs/adding-basic-conditional-statements-to-an-html-template.md)
- [Embedding merge fields into an HTML template](https://docs.inkit.com/docs/adding-merge-fields-to-an-html-template.md)
- [Building a full-featured HTML template](https://docs.inkit.com/docs/building-a-full-featured-html-template.md)
- [Creating HTML templates](https://docs.inkit.com/docs/creating-html-templates.md)
- [Embedding merge fields into a PDF template](https://docs.inkit.com/docs/adding-merge-fields-to-a-pdf-template.md)
- [Building a full-featured PDF template](https://docs.inkit.com/docs/building-a-full-featured-pdf-template.md)
- [Creating PDF templates](https://docs.inkit.com/docs/creating-pdf-templates.md)
- [Using Digital Signature in a Workflow](https://docs.inkit.com/docs/adding-digital-signature-as-a-document-destination-1.md): You can automate document signing by adding Digital Signature as a step in a Workflow.
- [Creating workflows](https://docs.inkit.com/docs/creating-flows.md)
- [Editing workflows](https://docs.inkit.com/docs/editing-flows.md)
- [Filtering workflows](https://docs.inkit.com/docs/filtering-flows.md)
- [Using workflows](https://docs.inkit.com/docs/using-flows.md)
- [Launching workflows](https://docs.inkit.com/docs/invoking-flows.md)

## API Reference
- [Batch delete files](https://docs.inkit.com/reference/batchdeletefiles.md): Delete multiple files at once
- [Delete a single file](https://docs.inkit.com/reference/deletefile.md): Delete a specific file by its public ID.  This endpoint accepts multiple types of public IDs: - **File ID** (prefix: `file_`) - Delete by file public ID - **Render Data ID** (prefix: `rend_`) - Delete by render data public ID - **Document ID** (prefix: `doc_`) - Delete by document public ID
- [Download a file](https://docs.inkit.com/reference/downloadfile.md): Download the actual file content.  This endpoint accepts multiple types of public IDs: - **File ID** (prefix: `file_`) - Download by file public ID - **Render Data ID** (prefix: `rend_`) - Download by render data public ID - **Document ID** (prefix: `doc_`) - Download by document public ID
- [List files](https://docs.inkit.com/reference/listfiles.md): Retrieve a paginated list of files
- [Retrieve file metadata](https://docs.inkit.com/reference/retrievefile.md): Get metadata for a specific file by its public ID.  This endpoint accepts multiple types of public IDs: - **File ID** (prefix: `file_`) - Retrieve by file public ID - **Render Data ID** (prefix: `rend_`) - Retrieve by render data public ID - **Document ID** (prefix: `doc_`) - Retrieve by document public ID
- [Upload a file](https://docs.inkit.com/reference/uploadfile.md): Upload a file to Inkit storage. Supports various file types including PDFs, documents, images, and more.  Maximum file size: 500MB
- [Send a template for signature](https://docs.inkit.com/reference/createrender.md): Generate a document from a template with specified destinations.  This endpoint allows you to generate a document from a template and optionally send it to various destinations such as Inkit Storage, Salesforce, and others.  **Note:** The `inkit_storage` destination is automatically added if not specified.
- [Get digital signature metadata](https://docs.inkit.com/reference/getdigitalsignaturemetadata.md): Get metadata for a digital signature by its public ID. Returns signer details, requester information, and document metadata including signing status, signature fields, and template associations.
- [Get render by ID](https://docs.inkit.com/reference/getrender.md): Retrieve detailed information about a specific render by its public ID
- [List renders](https://docs.inkit.com/reference/listrenders.md): Retrieve a paginated list of render data records.  Supports filtering, sorting, and searching through render history.
- [Invoke a workflow](https://docs.inkit.com/reference/invokeworkflow.md): Invoke a workflow to generate a document. The workflow must be configured with  the 'inkit_storage' destination and must be enabled.  This endpoint will initiate document generation based on the workflow configuration and provided merge parameters.

## Changelog
- [Redesign Phase 1.0 Completed](https://docs.inkit.com/changelog/redesign-phase-10-completed.md)
- [Shield Development](https://docs.inkit.com/changelog/shield-development.md)
- [Flows & New Integrations](https://docs.inkit.com/changelog/flows-new-integrations.md)
- [Various Updates](https://docs.inkit.com/changelog/various-updates-1.md)
- [Various Updates](https://docs.inkit.com/changelog/various-updates.md)