API Reference | FormKiQ

📄️ Introduction

Formkiq API: Document Management Platform API using OAuth(JWT) Authentication

📄️ Add New Case

Adds new case; available as an Add-On Module

📄️ Add document action

Add one or more actions to a document; this appends actions and does not replace previous actions

📄️ Add attribute to document

Add multiple attributes to a document; this endpoint also accepts a different body parameter for adding a single attribute

📄️ Add document's full-text

Add a document to OpenSearch; available as an Add-On Module

Generates a new document using a specified template file and data sources. This operation allows users to merge data from multiple documents into a template to create a new document in the desired output format (e.g., DOCX).

📄️ Perform document ocr

Document optical character recognition (OCR) request; extract text and data from a document;

📄️ Retries failed document action(s)

Retries all failed document action(s). Failed action status changes to 'FAILED_RETRY' and a new 'PENDING' action is created.

📄️ Add document sync to service

Add a document to a service

📄️ Add tag to document

Add multiple tags to a document; this endpoint also accepts a different body parameter for adding a single tag

📄️ Add large document

Returns a URL that can be used to upload document content and create a new document, while allowing metadata to also be sent; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB. The POST endpoint allow the adding of document metadata at the same time as the document is created.

📄️ Approve/Reject document in approval queue

Approve/Reject document in approval queue; available as an Add-On Module

📄️ Add document workflow

Creates a document workflow; available as an Add-On Module

📄️ Add new document

Creates a new document; body may include document content if less than 5 MB.

📄️ Create Docusign Envelope request

DocuSign create Docusign Envelope request; available as an Add-On Module

📄️ Create Docusign Recipient View request

DocuSign create Docusign Recipient View request; available as an Add-On Module

📄️ Add E-signature event

DocuSign callback URL handler; available as an Add-On Module

📄️ Add folder share

Creates a new folder share; available as an Add-On Module

📄️ Add document folder

Creates a new folder

📄️ Add Google Document Export

Exports a Google Document; available as an Add-On Module

📄️ Add a group

Add a new group

📄️ Add Locale Resource Item

Adds a new localized resource item for a given locale

📄️ Add Locale

Adds a new locale to the specified site

📄️ Add New Mapping

Creates a new mapping; available as an Add-On Module

📄️ Add New Nigo

Adds new nigo; available as an Add-On Module

📄️ Add queue

Creates a new Queue; available as an Add-On Module

📄️ Reindex metadata on a document

The API allows for the reindexing of a document's metadata determined by the target.

📄️ Add New Rule

Creates a new rule; available as an Add-On Module

📄️ Add New Ruleset

Creates a new ruleset; available as an Add-On Module

📄️ Add Site

Add Site

📄️ Add New Task

Adds new task; available as an Add-On Module

📄️ Add User to a group

Adds a user to a group

📄️ Add User

Adds a user

📄️ Add webhook

Receive an incoming private webhook and creates a document based on the webhook's body; requires authentication

📄️ Add webhook tag

Add a tag to a webhook

📄️ Add webhook

Create a new webhook; once created, a webhook's id can be provided to an external service, allowing data to be sent, received, and processed via that webhook

📄️ Add workflow

Creates a new Workflow; available as an Add-On Module

📄️ Compress multiple documents into a .zip file

Compress documents into an .ZIP archive file, and returns a S3 presigned url for the location of the archive file. The operation is async and processing time depends on the number and size of documents included; a 404 status code is returned until the file is ready.

📄️ Delete API Key

Adds a new API Key

📄️ Delete attribute

Delete a attribute

📄️ Delete Document from Case

Delete Document from Case

📄️ Delete Case

Delete Case

📄️ Delete Classification

Delete Classification

📄️ Delete document's attribute value

Delete a specific document attribute key/value combination; the request will be ignored if there is no valid key/value combination found

📄️ Delete document attribute

Delete a document attribute by using its key

📄️ Delete document full-text tag/value

Remove document tag/value from OpenSearch; available as an Add-On Module

📄️ Delete document full-text tag

Remove document tags from OpenSearch; available as an Add-On Module

📄️ Delete document full-text

Remove full text search for a document from OpenSearch; available as an Add-On Module

📄️ Delete document ocr

Delete a document's optical character recognition (OCR) result, if exists;

📄️ Delete document's tag value

Delete a specific document tag's key/value combination; the request will be ignored if there is no valid key/value combination found

📄️ Delete document tag

Delete a document tag by using its key

📄️ Delete document version

Delete a specific previous document version; available as an Add-On Module

📄️ Delete document

Delete a document's details, i.e., metadata, contents, etc

📄️ Delete document folder

Delete a specific folder; folder must be empty

📄️ Delete Group

Delete Group

📄️ DeleteIndex

Perform a delete on the Folder Index.

📄️ Delete Local Resource Item

Delete Local Resource Item

📄️ Delete Locale

Delete Locale

📄️ Delete Mapping

Delete Mapping; available as an Add-On Module

📄️ Delete Document from Nigo

Delete Document from Nigo

📄️ Delete Nigo

Delete Nigo

📄️ Delete OPA Access Policy Items

Delete OPA Access Policy Items

📄️ Deletes site(s) OpenSearch index

Deletes the OpenSearch index

📄️ Delete published document's contents

Delete a published document's contents. Certain content types, text/*, application/json, and application/x-www-form-urlencoded. return the 'content' field, while all other content types return a 'contentUrl' for retrieving the content.

📄️ Delete queue

Delete a Queue; available as an Add-On Module

📄️ Delete Rule

Delete Rule; available as an Add-On Module

📄️ Delete Ruleset

Delete Ruleset; available as an Add-On Module

📄️ Delete folder share

Delete a specific document share; available as an Add-On Module

📄️ Deletes Site Group and permissions

Deletes Site Group and permissions

📄️ Delete Document from Task

Delete Document from Task

📄️ Delete Task

Delete Task

📄️ Delete Username

Delete Username

📄️ Delete webhook

Delete a webhook; this will disable sending, receiving, or processing of data from external services to this webhook

📄️ Delete workflow

Delete a Workflow; available as an Add-On Module

📄️ Document search

Document search query request;

📄️ Get API Keys

Returns the list of ApiKeys

📄️ Get Attribute Allowed Values

Returns an attribute's allowed values that spans across all classifications and site schema

📄️ Get Attribute

Returns a attribute

📄️ Get Attributes listing

Returns a list of attributes

📄️ Get list of document in a case

Returns documents in a Case; available as an Add-On Module

📄️ Get nigo in a case

Returns a Nigo in Case; available as an Add-On Module

📄️ Get list of Nigos in a case

Returns a Nigos of Case; available as an Add-On Module

📄️ Get task in a case

Returns a Task in Case; available as an Add-On Module

📄️ Get list of tasks in a case

Returns a Case; available as an Add-On Module

📄️ Get Case details

Returns a Case; available as an Add-On Module

📄️ Get Case listing

Returns a list of the Cases; available as an Add-On Module

📄️ Get Classification's Attribute Allowed Values

Returns an attribute's allowed values that spans for a specific classifications and site schema

📄️ Get Classification

Get Classification

📄️ Get site configuration

Returns the list of sites that the user has access to

📄️ Get document actions

Get document actions and their status

📄️ Get document attribute's versions

Get a listing of a document's attribute versions; available as an Add-On Module

📄️ Get document attribute by key

Get a document attribute by using its key

📄️ Get document's attributes

Get a listing of a document's attributes

📄️ Get document's contents

Retrieves the content of the document with the specified `documentId`.

📄️ Get document's full-text

Retrieve an OpenSearch document's details, i.e., metadata

📄️ Get url to update large document

Returns a URL that can be used to upload documents for a specific documentId; this endpoint is required in order to add content that is larger than 5 MB. If versions are enabled, this will create a new version of the document.

📄️ Get document ocr content

Get a document's optical character recognition (OCR) result, if exists;

📄️ Get document syncs

Retrieve the document syncs with external services status

📄️ Get document tag by key

Get a document tag by using its key

📄️ Get document's tags

Get a listing of a document's tags

📄️ Get url to add large document

Returns a URL that can be used to upload document content and create a new document; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB

📄️ Get document content url

Returns a URL for the document's contents; this URL will expire (the default is 48 hours)

📄️ Get user activities for a document

Retrieve a user's activities for a document

📄️ Get document's versions

Get a listing of document content and metadata versions; available as an Add-On Module

📄️ Get document workflow

Gets a document workflow; available as an Add-On Module

📄️ Get document workflows

Gets a document workflows; available as an Add-On Module

📄️ Get document

Retrieves a document's details, i.e., metadata

📄️ Get Documents listing

Returns a list of the most recent documents added, ordered by inserted, descending

📄️ Add Examine Pdf

Get Signed URL for PDF Object Upload of a document to be examined by calling GET /objects/examine/{id}/pdf

📄️ Add Examine Pdf

Get PDF details

📄️ Get document folders

Get list of documents in a folder

📄️ Get a user group

Returns a user group

📄️ Get list of user group(s)

Returns the list of user groups

📄️ Returns a list of group user belongs to

Returns a list of group user belongs to

📄️ Get Resource Item by Locale

Returns the resource item

📄️ Get Resource Items by Locale

Returns the list resource items

📄️ Get Locales

Returns a list of locale(s) in a specified site

📄️ Get Mapping

Get a mapping; available as an Add-On Module

📄️ Get Mappings

Returns a list of mappings; available as an Add-On Module

📄️ Get list of document in a task

Returns a list documents in a Case; available as an Add-On Module

📄️ Get OPAs Access Policies

Returns a list of OPA Access Policies, can only be requested with ADMIN privileges

📄️ Get OPA Access Policy Items

Returns OPA Access Policy Items, can only be requested with ADMIN privileges

📄️ Get OPA Access Policy

Returns OPA Access Policy, can only be requested with ADMIN privileges

📄️ Get site(s) OpenSearch index settings

Returns the OpenSearch index settings

📄️ Get published document's contents

Get a published document's contents. Certain content types, text/*, application/json, and application/x-www-form-urlencoded. return the 'content' field, while all other content types return a 'contentUrl' for retrieving the content.

📄️ Get queue

Get a queue; available as an Add-On Module

📄️ Get queues

Get a listing of queues; available as an Add-On Module

📄️ Get Rule

Returns a rule in a ruleset; available as an Add-On Module

📄️ Get Rules

Returns a list of rules in a ruleset; available as an Add-On Module

📄️ Get Ruleset

Get a rule sets; available as an Add-On Module

📄️ Get Rulesets

Returns a list of rule sets; available as an Add-On Module

📄️ Get group and permissions belonging to site

Returns details of a group and permissions belonging to site

📄️ Get group(s) and permissions belonging to site

Returns list of groups and permissions belonging to site

📄️ Get Sites Classifications

Gets Sites Classifications

📄️ Get Attribute Allowed Values

Returns an attribute's allowed values from the site schema

📄️ Get Sites Schema

Gets Sites schema

📄️ Get site(s) access

Returns the list of sites that the user has access to

📄️ Get list of document in a task

Returns a list documents in a Case; available as an Add-On Module

📄️ Get user activities

Retrieve a user's activities

📄️ Get user shared folders

Get a listing of user folder/document shares; available as an Add-On Module

📄️ Get a user

Returns a user

📄️ Get users in a group

Returns the list of users in a group

📄️ Get list of user(s)

Returns the list of users

📄️ Get FormKiQ version

Return the version of FormKiQ

📄️ Get webhook tags

Get a webhook's tags

📄️ Get webhook

Return a webhook's details, i.e., its metadata

📄️ Get webhooks

Return a list of webhooks; each webhook's id can be provided to an external service, allowing data to be sent, received, and processed via that webhook

📄️ Get list of documents in workflow

List documents in Workflow; available as an Add-On Module

📄️ Get list of documents in queue

List documents in Workflow Queue; available as an Add-On Module

📄️ Get workflow

Get a workflow; available as an Add-On Module

📄️ Get workflows

Get a listing of workflows; available as an Add-On Module

📄️ IndexFolderMove

Perform an Folder Index Move

📄️ IndexSearch

Perform a search on a index; this is currently available for both folder and tag indices

📄️ Public add document

Allow unauthenticated creation of new documents; must be enabled during installation (disabled by default)

📄️ Public add webhook

Receive an incoming public post to a specified webhook and creates a document based on the data sent; must be enabled during installation (disabled by default)

📄️ Purge document

Remove all objects from the S3 bucket, including previous versions and current version, and should remove all metadata as well, so that no trace of the document exists outside of the audit logs and any backups. Can only be called be ADMIN or GOVERN.

📄️ Direct opensearch search API

Endpoint for allowing custom, complex queries using the OpenSearch search API (https://opensearch.org/docs/latest/opensearch/rest-api/search/); available as an Add-On Module