Skip to main content

How do I add document upload and storage to my application?

Call FormKiQ's document API from your application to store files and metadata in your AWS deployment. Use an inline request for small content or request a presigned S3 URL for file uploads. Save the returned document ID, then retrieve metadata, content URLs, and processing status through authorized API requests.

Choose the upload path​

For a small text document, POST /documents accepts path, contentType, and content. For file bytes, POST /documents/upload returns a temporary upload URL and document ID. Upload to that URL using the returned headers. The detailed upload guide provides complete cURL examples for both paths.

Keep your application's business-record identifier in a defined attribute and persist FormKiQ's documentId in your database. This lets a support case or invoice find its documents without relying on a filename. Choose the correct siteId on every request in a multi-site application.

Separate transfer from processing​

A successful file transfer does not mean OCR, antivirus, indexing, or review has finished. Read document/action state before showing the document as ready. Build an error state for failed processing and a retry policy that reconciles an uncertain create result before sending another create request.

Keep application credentials on the appropriate trusted boundary. A browser may use its user's JWT or an authorized server endpoint; it must not receive a broadly privileged service credential.

Edition and configuration​

Document APIs are available in Core. OCR engines, workflows, scanning, and other processing depend on the installed edition and configured capabilities.

Continue with the detailed guides​

Privacy settings

Analytics is optional. Your analytics choice is shared with formkiq.com and remembered for up to six months. Change it here at any time.

Essential preferences and search

We remember your privacy choice and display preferences. Search runs in your browser using Pagefind files hosted with the docs. It works whether you accept or reject analytics.

Measure page views and installation-link clicks. This does not enable advertising on the docs. Existing marketing choices for the main website are kept unchanged.

Read the docs privacy notice or manage other main-website privacy choices.