Skip to main content

How do I enforce required metadata on uploaded documents?

Configure FormKiQ site or classification schemas to define required attributes, value types, and allowed values for the relevant documents. Use the supported validation path for your installed release and test every ingestion client. A required field in a web form alone does not prove that direct API uploads, imports, or later updates enforce the same rule.

Define the metadata contract​

Start with a concrete document type. An invoice might require an invoice identifier, a vendor identifier, a numeric total, and a consistent date string. Create the attribute definitions, assign the appropriate schema, and specify allowed values where business rules require them.

Keep classification choice and required fields aligned. If classification is supplied after OCR or review, decide which metadata is mandatory at intake and which must be complete before the document advances. Do not require unavailable extracted values merely to store the source evidence.

Test enforcement at the boundary​

Use the schema tutorial's exact request shapes. Submit one valid document, one missing a required value, and one containing a wrong type or disallowed value. Test subsequent updates as well as creation through the API, Web, and migration path you intend to use.

Show validation errors to callers without silently dropping fields. Route incomplete extracted data to a review queue. A schema validates metadata; it does not establish that an OCR or AI value matches the source document.

Edition and configuration​

Core provides site/classification schemas and attribute APIs. Confirm the supported schema behavior and ingestion path for the deployed release; commercial processing and workflow configuration are separate.

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.