# Inkit Documentation

> Inkit is your secure File Intelligence Platform, built to organize, search, and share your documents with ease. AI-powered document generation, digital signature, workflow automation, organization, storage, and search - all in one place. Inkit's platform is designed for everyday use, even in the most regulated industries. Founded in 2019, Inkit is privately owned with offices in Saint Paul, Minnesota and San Juan, Puerto Rico. Visit inkit.com to learn more.

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Welcome to Inkit](https://inkit.readme.io/docs/welcome-to-inkit.md)
- [Features](https://inkit.readme.io/docs/about-inkit.md)
- [Signing up with Inkit for Commercial](https://inkit.readme.io/docs/user-signup-options.md)
- [Signing up with Inkit for Government](https://inkit.readme.io/docs/signing-up-with-inkit-for-dod.md)
- [Quickstart: Generating your first document](https://inkit.readme.io/docs/generating-your-first-document.md)
- [Managing users and roles](https://inkit.readme.io/docs/managing-users-and-roles.md)
- [Adding a user](https://inkit.readme.io/docs/adding-a-user.md)
- [Editing a user](https://inkit.readme.io/docs/editing-a-user.md)
- [Adding a role](https://inkit.readme.io/docs/adding-a-role.md)
- [Editing a role](https://inkit.readme.io/docs/editing-a-role.md)
- [Assigning roles to a user](https://inkit.readme.io/docs/assigning-a-role-to-a-user.md)
- [Inkit permissions](https://inkit.readme.io/docs/permissions-in-inkit.md)
- [Using folders](https://inkit.readme.io/docs/using-folders.md)
- [Adding, editing and removing folders](https://inkit.readme.io/docs/adding-editing-and-removing-folders.md)
- [Sharing folders](https://inkit.readme.io/docs/sharing-folders.md)
- [Traversing folders](https://inkit.readme.io/docs/traversing-folders.md)
- [Specifying folders when generating documents](https://inkit.readme.io/docs/specifying-folders-when-generating-documents.md)
- [Performing administrative tasks](https://inkit.readme.io/docs/performing-administrative-tasks.md)
- [Using audit logs](https://inkit.readme.io/docs/using-audit-logs.md)
- [Adding two-factor authentication](https://inkit.readme.io/docs/adding-two-factor-authentication.md)
- [Digital Signature](https://inkit.readme.io/docs/digital-signatures.md)
- [Sending a document for Digital Signature](https://inkit.readme.io/docs/sending-a-document-for-digital-signature.md): Choose whether to upload a document or use a reusable template, then send it for signature.
- [Signing a Digital Signature document](https://inkit.readme.io/docs/signing-a-digital-signature-document.md)
- [Using the Digital Signature Dashboard](https://inkit.readme.io/docs/using-the-digital-dignature-dashboard.md)
- [Understanding Digital Signature statuses](https://inkit.readme.io/docs/using-the-digital-signature-statuses.md)
- [Reassigning a signer](https://inkit.readme.io/docs/reassign-a-signature.md): Change the assigned signer if the original recipient is unavailable or entered incorrectly.
- [Canceling a signature](https://inkit.readme.io/docs/canceling-a-signature.md): Stop a signature request if it was sent in error or is no longer needed.
- [Sending reminders to signers](https://inkit.readme.io/docs/sending-reminders.md): Gently remind recipients to sign their documents if they haven’t already.
- [Adding Digital Signature blocks to a PDF template](https://inkit.readme.io/docs/embedding-digital-signature-fields-in-a-pdf-template.md)
- [Adding Digital Signature blocks to a DOCX template](https://inkit.readme.io/docs/embedding-digital-signature-fields-in-a-docx-template.md)
- [Adding Digital Signature blocks to an HTML template](https://inkit.readme.io/docs/embedding-digital-signature-fields-in-an-html-template.md)
- [Using Signing Groups for flexible signing](https://inkit.readme.io/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.
- [Accessing the Certificate of Completion](https://inkit.readme.io/docs/accessing-the-certificate-of-completion.md): After a document has been signed, you can download a certificate of completion for your records.
- [Creating and editing templates](https://inkit.readme.io/docs/creating-and-editing-templates.md)
- [Creating PDF templates](https://inkit.readme.io/docs/creating-pdf-templates.md)
- [Embedding merge fields into a PDF template](https://inkit.readme.io/docs/adding-merge-fields-to-a-pdf-template.md)
- [Building a full-featured PDF template](https://inkit.readme.io/docs/building-a-full-featured-pdf-template.md)
- [Creating DOCX templates](https://inkit.readme.io/docs/creating-docx-templates.md)
- [Embedding merge fields into a DOCX template](https://inkit.readme.io/docs/adding-merge-fields-to-a-docx-template.md)
- [Embedding basic conditional statements into a DOCX template](https://inkit.readme.io/docs/adding-basic-conditional-statements-to-a-docx-template.md)
- [Iterating through a list or a table in a DOCX template](https://inkit.readme.io/docs/iterating-through-a-list-or-a-table-in-a-docx-template.md)
- [Building a full-featured DOCX template](https://inkit.readme.io/docs/building-a-full-featured-docx-template.md)
- [Creating HTML templates](https://inkit.readme.io/docs/creating-html-templates.md)
- [Embedding merge fields into an HTML template](https://inkit.readme.io/docs/adding-merge-fields-to-an-html-template.md)
- [Embedding basic conditional statements into an HTML template](https://inkit.readme.io/docs/adding-basic-conditional-statements-to-an-html-template.md)
- [Building a full-featured HTML template](https://inkit.readme.io/docs/building-a-full-featured-html-template.md)
- [Generating documents using the web app](https://inkit.readme.io/docs/generating-documents-in-the-inkit-web-app.md)
- [Generating documents using the web app (Government)](https://inkit.readme.io/docs/generating-documents-using-the-web-app-gov.md)
- [Generating documents using the API](https://inkit.readme.io/docs/generating-documents-using-the-inkit-api.md)
- [Generating documents that expire](https://inkit.readme.io/docs/generating-documents-that-expire.md)
- [Setting Digital Signature as a document destination](https://inkit.readme.io/docs/adding-digital-signature-as-a-document-destination.md)
- [Displaying documents](https://inkit.readme.io/docs/displaying-generated-documents.md)
- [Using workflows](https://inkit.readme.io/docs/using-flows.md)
- [Creating workflows](https://inkit.readme.io/docs/creating-flows.md)
- [Editing workflows](https://inkit.readme.io/docs/editing-flows.md)
- [Launching workflows](https://inkit.readme.io/docs/invoking-flows.md)
- [Filtering workflows](https://inkit.readme.io/docs/filtering-flows.md)
- [Using Digital Signature in a Workflow](https://inkit.readme.io/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.
- [Adding, editing and removing API keys](https://inkit.readme.io/docs/adding-and-removing-api-keys.md)
- [Regenerating API keys](https://inkit.readme.io/docs/generating-api-keys.md)
- [Storing API keys](https://inkit.readme.io/docs/storing-api-keys.md)
- [Specifying API keys in your applications](https://inkit.readme.io/docs/specifying-api-keys-in-your-applications.md)
- [API endpoints](https://inkit.readme.io/docs/api-endpoints.md)
- [Making API requests](https://inkit.readme.io/docs/making-api-requests.md)
- [Paging through list requests](https://inkit.readme.io/docs/paginating-list-requests.md)
- [Standard API request and response objects](https://inkit.readme.io/docs/api-request-objects.md)
- [Generate Document](https://inkit.readme.io/docs/generate-document.md): _Generates a document from a template and a set of merge parameters and stores it in a destination_
- [Launch Workflow](https://inkit.readme.io/docs/launch-flow.md): _Launches a workflow and generates a document to a set of destinations_
- [List Workflow Statuses](https://inkit.readme.io/docs/flow-statuses.md): _Lists workflows invoked and their statuses_
- [Launch Workflow Batch](https://inkit.readme.io/docs/generate-flow-batch.md): _Launches a set of workflows_
- [Retrieve Workflow Batch Information](https://inkit.readme.io/docs/retrieve-flow-batch-information.md): _Retrieves information about a batch of workflows_
- [List Workflow Batches](https://inkit.readme.io/docs/list-flow-batches.md): _Lists workflow batches created_
- [List Folders](https://inkit.readme.io/docs/list-folders.md): _Lists private folders in Inkit Storage_
- [Create Template](https://inkit.readme.io/docs/create-template.md): _Creates a document template_
- [Retrieve Template Information](https://inkit.readme.io/docs/retrieve-template.md): _Retrieves information about a document template_
- [List Templates](https://inkit.readme.io/docs/list-templates.md): _Lists document templates_
- [Retrieve Mail Piece Status](https://inkit.readme.io/docs/retrieve-mail-pieces-status.md): _Retrieves information about the delivery status of a Sepire mail piece_
- [Send Digital Signature](https://inkit.readme.io/docs/digital_signature.md)
- [Using webhooks](https://inkit.readme.io/docs/managing-webhooks.md)
- [Adding, editing and removing webhooks](https://inkit.readme.io/docs/adding-editing-and-removing-webhooks.md)
- [Processing webhooks on your server](https://inkit.readme.io/docs/connecting-webhooks.md)
- [Inkit webhook events](https://inkit.readme.io/docs/inkit-webhook-events.md)
- [Storing webhook secret keys](https://inkit.readme.io/docs/storing-webhook-secret-keys.md)

## API Reference
- [Send a template for signature](https://inkit.readme.io/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://inkit.readme.io/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.
- [List renders](https://inkit.readme.io/reference/listrenders.md): Retrieve a paginated list of render data records.  Supports filtering, sorting, and searching through render history.
- [Get render by ID](https://inkit.readme.io/reference/getrender.md): Retrieve detailed information about a specific render by its public ID
- [Upload a file](https://inkit.readme.io/reference/uploadfile.md): Upload a file to Inkit storage. Supports various file types including PDFs, documents, images, and more.  Maximum file size: 500MB
- [List files](https://inkit.readme.io/reference/listfiles.md): Retrieve a paginated list of files
- [Retrieve file metadata](https://inkit.readme.io/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
- [Download a file](https://inkit.readme.io/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
- [Batch delete files](https://inkit.readme.io/reference/batchdeletefiles.md): Delete multiple files at once
- [Delete a single file](https://inkit.readme.io/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
- [Invoke a workflow](https://inkit.readme.io/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://inkit.readme.io/changelog/redesign-phase-10-completed.md)
- [Shield Development](https://inkit.readme.io/changelog/shield-development.md)
- [Flows & New Integrations](https://inkit.readme.io/changelog/flows-new-integrations.md)
- [Various Updates](https://inkit.readme.io/changelog/various-updates-1.md)
- [Various Updates](https://inkit.readme.io/changelog/various-updates.md)
- [Docusign & Salesforce Integration](https://inkit.readme.io/changelog/docusign-salesforce-integration.md)
- [Template & Dashboard Page Updates](https://inkit.readme.io/changelog/template-dashboard-overhauls.md)
- [Apps Page Updates](https://inkit.readme.io/changelog/apps-page-updates.md)
- [API Update](https://inkit.readme.io/changelog/api-update.md)
- [Template Destinations](https://inkit.readme.io/changelog/template-destinations.md)