How-to Guides

Use these task-focused guides when you need to complete a specific API or migration workflow.

Documents

Add Documents

Add documents through the FormKiQ API.

Metadata

Attach tags and metadata to documents for organization and retrieval.

Search documents through API-driven query workflows.

Automation

Trigger and inspect document processing actions.

Authentication

Get a JWT token for API requests and Postman-based testing.

Administration

Create users, assign groups, and set site permissions.

Integration

Create, use, rotate, and revoke API keys for server-side integrations.

Access Control

Create folders, assign permissions, and share folders with groups.

Lifecycle

Inspect versions, restore a version, check out a document, and apply legal hold.

Automation

Create and test webhook intake workflows.

Run OCR, inspect extracted text, add full-text content, and search it.

Governance

Retrieve document, user, and resource activity for audit workflows.

Migration

Migrate data between FormKiQ Core and Enterprise environments.