# ABBYY FlexiCapture: Programmer's Guide

> FlexiCapture API (objects, methods, properties, and events), Web Station integration and customization, custom reports, and appendix.
> For the full ABBYY documentation index, see: https://docs.abbyy.com/llms.txt

## Application Programming Interface (API)

- [Application Programming Interface (API)](https://docs.abbyy.com/flexi-capture/api/overview/api.md): Connect external systems to the ABBYY FlexiCapture Application Server over SOAP and HTTP to create document processing tasks, run them, and retrieve results.
- [Migrate from earlier versions of the Web Services API](https://docs.abbyy.com/flexi-capture/api/overview/migrating.md): Review the breaking changes between the new ABBYY FlexiCapture Web Services API and earlier WSDL versions, including updated methods, data types, and endpoints.
- [Use the Web Services API of the ABBYY FlexiCapture Application Server](https://docs.abbyy.com/flexi-capture/api/using/using.md): Walk through the standard ABBYY FlexiCapture Web Services API scenario: connect, scan and send documents, verify, rescan, and retrieve processing results.
- [Connect to the Web Services API](https://docs.abbyy.com/flexi-capture/api/using/connecting.md): Connect to the ABBYY FlexiCapture Web Services API through SOAP, JSON, or POST requests, and authenticate with a Windows or FlexiCapture account.
- [Scan documents](https://docs.abbyy.com/flexi-capture/api/using/scanning-api-using.md): Scan documents through the ABBYY FlexiCapture Web Services API by opening a session and project, creating a batch, adding pages, and starting processing.
- [Verify documents](https://docs.abbyy.com/flexi-capture/api/using/verification.md): Verify documents through the ABBYY FlexiCapture Web Services API by requesting a task, fetching its files, editing them, and returning the task to the server.
- [Rescan documents](https://docs.abbyy.com/flexi-capture/api/using/rescanning-api-using.md): Rescan documents through the ABBYY FlexiCapture Web Services API by requesting a task, replacing or adding page images, and then returning it to Scanning.
- [Get processing results](https://docs.abbyy.com/flexi-capture/api/using/results.md): Retrieve exported document processing results through the ABBYY FlexiCapture Web Services API by listing and loading the result files for a project.
- [References](https://docs.abbyy.com/flexi-capture/api/structures/references.md): Reference section for the ABBYY FlexiCapture Web Services API, covering the available methods, the data types used, and how to work with files on the server.
- [API Methods](https://docs.abbyy.com/flexi-capture/api/methods/methods.md): Browse the full set of ABBYY FlexiCapture Web Services API methods, grouped by sessions, projects, batches, tasks, documents, pages, users, files, and more.
- [Sessions](https://docs.abbyy.com/flexi-capture/api/methods/sessions.md): ABBYY FlexiCapture Web Services API methods for managing connection sessions: open and close sessions, check whether one exists, and get session information.
- [CloseSession](https://docs.abbyy.com/flexi-capture/api/methods/close-session.md): CloseSession method in the ABBYY FlexiCapture Web Services API closes a previously opened connection to the Application Server using its session ID.
- [GetSessionInfo](https://docs.abbyy.com/flexi-capture/api/methods/get-session-info.md): GetSessionInfo method in the ABBYY FlexiCapture Web Services API returns the user name, computer name, role type, and user ID for a given session.
- [IsSessionExists](https://docs.abbyy.com/flexi-capture/api/methods/is-session-exists.md): IsSessionExists in the ABBYY FlexiCapture Web Services API checks whether a connection session with the specified ID currently exists, returning a boolean.
- [OpenSession](https://docs.abbyy.com/flexi-capture/api/methods/open-session.md): OpenSession in the ABBYY FlexiCapture Web Services API opens an Application Server connection for a valid role and station type, returning a session ID.
- [OpenSessionEx](https://docs.abbyy.com/flexi-capture/api/methods/open-session-ex.md): Open a connection to the FlexiCapture Application Server with the OpenSessionEx Web Services API method.
- [Projects](https://docs.abbyy.com/flexi-capture/api/methods/projects.md): ABBYY FlexiCapture Web Services API methods for working with projects: open and close projects and list the projects loaded onto the Application Server.
- [CloseProject](https://docs.abbyy.com/flexi-capture/api/methods/close-project.md): CloseProject method in the ABBYY FlexiCapture Web Services API closes a previously opened project, identified by its session ID and project ID.
- [GetProjects](https://docs.abbyy.com/flexi-capture/api/methods/get-projects.md): GetProjects method in the ABBYY FlexiCapture Web Services API returns an array of Project records describing every project loaded onto the Application Server.
- [OpenProject](https://docs.abbyy.com/flexi-capture/api/methods/open-project.md): OpenProject method in the ABBYY FlexiCapture Web Services API opens a project by name or GUID for further work and returns the ID of the opened project.
- [Batch types](https://docs.abbyy.com/flexi-capture/api/methods/batch-types-api-methods.md): ABBYY FlexiCapture Web Services API methods for batch types: list available batch types, get batch type details and processing stages, and check access rights.
- [GetAllowedBatchTypes](https://docs.abbyy.com/flexi-capture/api/methods/get-allowed-batch-types.md): GetAllowedBatchTypes method in the ABBYY FlexiCapture Web Services API returns the batch types within a project that are available to a user with a given role.
- [GetProcessingStages](https://docs.abbyy.com/flexi-capture/api/methods/get-processing-stages.md): GetProcessingStages in the ABBYY FlexiCapture Web Services API returns ProcessingStage records filtered by project, batch type, stage type, and stage name.
- [GetProcessingStagesExt](https://docs.abbyy.com/flexi-capture/api/methods/get-processing-stages-ext.md): GetProcessingStagesExt method in the ABBYY FlexiCapture Web Services API returns extended information about processing stages.
- [HasRightsForBatchType](https://docs.abbyy.com/flexi-capture/api/methods/has-rights-for-batch-type.md): HasRightsForBatchType method in the ABBYY FlexiCapture Web Services API checks whether a specified user role has access permissions to a given batch type.
- [Batches](https://docs.abbyy.com/flexi-capture/api/methods/batches-api-methods.md): ABBYY FlexiCapture Web Services API methods for working with batches: add, open, close, delete, and update batches, add images, and start batch processing.
- [AddNewBatch](https://docs.abbyy.com/flexi-capture/api/methods/add-new-batch.md): Add a new batch to a project and assign its owner with the AddNewBatch method of the ABBYY FlexiCapture Web Services API, which returns the new batch ID.
- [AddNewBatchExt](https://docs.abbyy.com/flexi-capture/api/methods/add-new-batch-ext.md): Add a batch to a FlexiCapture project and set its owner with the AddNewBatchExt Web Services API method.
- [AddNewImage](https://docs.abbyy.com/flexi-capture/api/methods/add-new-image.md): Add an image or multi-page file to a batch with the AddNewImage method of the ABBYY FlexiCapture Web Services API, and then process the batch to access pages.
- [CloseBatch](https://docs.abbyy.com/flexi-capture/api/methods/close-batch.md): Close a batch and unlock it for deletion using the CloseBatch method of the ABBYY FlexiCapture Web Services API, identifying the batch by its ID.
- [DeleteBatch](https://docs.abbyy.com/flexi-capture/api/methods/delete-batch.md): Delete a batch and its exported documents with the DeleteBatch method of the ABBYY FlexiCapture Web Services API, which returns a success flag.
- [GetBatch](https://docs.abbyy.com/flexi-capture/api/methods/get-batch.md): Retrieve information about a single batch by its ID using the GetBatch method of the ABBYY FlexiCapture Web Services API, which returns a Batch structure.
- [GetBatches](https://docs.abbyy.com/flexi-capture/api/methods/get-batches.md): List all batches in a project with the GetBatches method of the ABBYY FlexiCapture Web Services API, optionally limited to the current user or group.
- [GetBatchesExt](https://docs.abbyy.com/flexi-capture/api/methods/get-batches-ext.md): Get extended information about all batches in a FlexiCapture project with the GetBatchesExt Web Services API method.
- [GetDetailedBatch](https://docs.abbyy.com/flexi-capture/api/methods/get-detailed-batch.md): Get extended information about a FlexiCapture batch with the GetDetailedBatch Web Services API method.
- [GetDetailedBatches](https://docs.abbyy.com/flexi-capture/api/methods/get-detailed-batches.md): Get extended information about FlexiCapture batches with the GetDetailedBatches Web Services API method.
- [GetDetailedBatches2](https://docs.abbyy.com/flexi-capture/api/methods/get-detailed-batches2.md): GetDetailedBatches2 method in the ABBYY FlexiCapture Web Services API returns a list of batches with an expanded set of fields.
- [GetBatchIdsRange](https://docs.abbyy.com/flexi-capture/api/methods/get-batch-ids-range.md): Reserve a range of document and page IDs in a batch with the GetBatchIdsRange method of the ABBYY FlexiCapture Web Services API, returning the first ID.
- [GetBatchPercentCompleted](https://docs.abbyy.com/flexi-capture/api/methods/get-batch-percent-completed.md): Check batch processing progress as a percentage with the GetBatchPercentCompleted method of the ABBYY FlexiCapture Web Services API, identified by batch ID.
- [GetBatchType](https://docs.abbyy.com/flexi-capture/api/methods/get-batchtype.md): Retrieve information about a batch type by its ID using the GetBatchType method of the ABBYY FlexiCapture Web Services API, which returns a BatchType structure.
- [GetBatchTypes](https://docs.abbyy.com/flexi-capture/api/methods/get-batch-types.md): List all batch types within a project with the GetBatchTypes method of the ABBYY FlexiCapture Web Services API, returning an array of BatchType structures.
- [GetFilteredBatches](https://docs.abbyy.com/flexi-capture/get-filtered-batches.md): Request a filtered, paged set of batches with the GetFilteredBatches method of the ABBYY FlexiCapture Web Services API, using stage, date, and SLA filters.
- [OpenBatch](https://docs.abbyy.com/flexi-capture/api/methods/open-batch.md): Open a batch and lock it against deletion by other connections with the OpenBatch method of the ABBYY FlexiCapture Web Services API, returning a success flag.
- [ProcessBatch](https://docs.abbyy.com/flexi-capture/api/methods/process-batch.md): Start processing a batch and send it to the Import stage with the ProcessBatch method of the ABBYY FlexiCapture Web Services API, identified by batch ID.
- [UpdateBatch](https://docs.abbyy.com/flexi-capture/api/methods/update-batch.md): Change a batch header with the UpdateBatch method of the ABBYY FlexiCapture Web Services API, editing Name, BatchTypeId, Priority, and other parameters.
- [Tasks](https://docs.abbyy.com/flexi-capture/api/methods/tasks.md): Browse the ABBYY FlexiCapture Web Services API methods for working with tasks: create, open, close, cancel, postpone, send, and prioritize them across stages.
- [CancelTask](https://docs.abbyy.com/flexi-capture/api/methods/cancel-task.md): Cancel the processing of a task with the CancelTask method of the ABBYY FlexiCapture Web Services API, identifying the task by its ID.
- [CloseTask](https://docs.abbyy.com/flexi-capture/api/methods/close-task.md): Close a task and route it to a processing stage with the CloseTask method of the ABBYY FlexiCapture Web Services API, optionally using a RoutingInfo schema.
- [CloseTaskEx](https://docs.abbyy.com/flexi-capture/api/methods/close-task-ex.md): Return a task for further processing and route documents to a stage with the CloseTaskEx Web Services API method.
- [CreateTask](https://docs.abbyy.com/flexi-capture/api/methods/create-task.md): Create a task from documents in one batch with the CreateTask method of the ABBYY FlexiCapture Web Services API, setting stage, priority, owner, and queue.
- [GetAvailableTasks](https://docs.abbyy.com/flexi-capture/api/methods/get-available-tasks.md): List tasks available at a processing stage of a given type with the GetAvailableTasks method of the ABBYY FlexiCapture Web Services API as a Task array.
- [GetAvailableTasksExt](https://docs.abbyy.com/flexi-capture/api/methods/get-available-tasks-ext.md): GetAvailableTasksExt method in the ABBYY FlexiCapture Web Services API lists tasks available at a processing stage of the specified type.
- [GetAvailableTasksByStageId](https://docs.abbyy.com/flexi-capture/api/methods/get-available-tasks-by-stage-id.md): List session tasks available at specified stages with the GetAvailableTasksByStageId method of the ABBYY FlexiCapture Web Services API, filtered by stage IDs.
- [GetAvailableTasksByStageIdExt](https://docs.abbyy.com/flexi-capture/api/methods/get-available-tasks-by-stage-id-ext.md): GetAvailableTasksByStageIdExt method in the ABBYY FlexiCapture Web Services API lists tasks available at the specified processing stages.
- [GetAvailableQueues](https://docs.abbyy.com/flexi-capture/api/methods/get-available-queues.md): Retrieve the processing stages available to the user with the GetAvailableQueues method of the ABBYY FlexiCapture Web Services API, returning a Queue array.
- [GetCurrentTask](https://docs.abbyy.com/flexi-capture/api/methods/get-current-task.md): Return the ID of the current task for a session with the GetCurrentTask method of the ABBYY FlexiCapture Web Services API, using the connection ID.
- [GetPostponedTasks](https://docs.abbyy.com/flexi-capture/api/methods/get-postponed-tasks.md): List postponed tasks at a specified processing stage with the GetPostponedTasks method of the ABBYY FlexiCapture Web Services API, returning a Task array.
- [GetTask](https://docs.abbyy.com/flexi-capture/api/methods/get-task.md): Select the highest-priority task at a stage type and lock it with the GetTask method of the ABBYY FlexiCapture Web Services API, returning the task ID.
- [GetTaskExt](https://docs.abbyy.com/flexi-capture/api/methods/get-task-ext.md): GetTaskExt method in the ABBYY FlexiCapture Web Services API selects the highest-priority task by stage type and opens it for processing.
- [GetTaskByStageId](https://docs.abbyy.com/flexi-capture/api/methods/get-task-by-stage-id.md): Select and lock the highest-priority task at given stage IDs with the GetTaskByStageId method of the ABBYY FlexiCapture Web Services API, returning its ID.
- [GetTaskByStageIdExt](https://docs.abbyy.com/flexi-capture/api/methods/get-task-by-stage-id-ext.md): GetTaskByStageIdExt method in the ABBYY FlexiCapture Web Services API selects the highest-priority task by stage IDs and opens it for processing.
- [GetTaskDocuments](https://docs.abbyy.com/flexi-capture/api/methods/get-task-documents.md): GetTaskDocuments method in the ABBYY FlexiCapture web services API returns a Document array describing every document contained in a task by its task ID.
- [GetTaskInfo](https://docs.abbyy.com/flexi-capture/api/methods/get-task-info.md): GetTaskInfo method in the ABBYY FlexiCapture web services API retrieves a Task object with details about a task identified by its task ID.
- [GetTaskInfoExt](https://docs.abbyy.com/flexi-capture/api/methods/get-task-info-ext.md): GetTaskInfoExt method in the ABBYY FlexiCapture Web Services API returns extended information about a task.
- [OpenTask](https://docs.abbyy.com/flexi-capture/api/methods/open-task.md): OpenTask method in the ABBYY FlexiCapture web services API opens and locks a task for further operations so other users cannot access it at the same time.
- [PostponeTask](https://docs.abbyy.com/flexi-capture/api/methods/postpone-task.md): PostponeTask method in the ABBYY FlexiCapture web services API defers a task for processing at a later time and attaches an optional comment to it.
- [SendTask](https://docs.abbyy.com/flexi-capture/api/methods/send-task.md): SendTask method in the ABBYY FlexiCapture web services API sends an entire task to a specified processing stage and attaches a comment to it.
- [SendTaskToException](https://docs.abbyy.com/flexi-capture/api/methods/send-task-to-exception.md): SendTaskToException method in the ABBYY FlexiCapture web services API routes a task to the Exceptions stage, with an optional comment and post-processing flag.
- [SetTaskPriority](https://docs.abbyy.com/flexi-capture/api/methods/set-task-priority.md): SetTaskPriority method in the ABBYY FlexiCapture web services API changes the processing priority of a task using a value from the Priority enumeration.
- [Documents](https://docs.abbyy.com/flexi-capture/api/methods/documents-api-methods.md): Reference to the ABBYY FlexiCapture web services API methods for working with documents: add, delete, retrieve, set properties, and load export results.
- [AddNewDocument](https://docs.abbyy.com/flexi-capture/api/methods/add-new-document.md): AddNewDocument method in the ABBYY FlexiCapture web services API adds a new document from an image file into a batch and controls its assembly and position.
- [AddNewDocumentEx](https://docs.abbyy.com/flexi-capture/api/methods/add-new-document-ex.md): Add a document from an image file to a FlexiCapture batch with the AddNewDocumentEx Web Services API method.
- [AddNewEmptyDocument](https://docs.abbyy.com/flexi-capture/api/methods/add-new-empty-document.md): Add an empty document to a FlexiCapture batch with the AddNewEmptyDocument Web Services API method, and then attach pages.
- [DeleteDocument](https://docs.abbyy.com/flexi-capture/api/methods/delete-document.md): DeleteDocument method in the ABBYY FlexiCapture web services API removes a document from a batch along with its export results, returning a success flag.
- [GetDocument](https://docs.abbyy.com/flexi-capture/api/methods/get-document.md): GetDocument method in the ABBYY FlexiCapture web services API retrieves extended information about a single document in a batch as a Document object.
- [GetDocument2](https://docs.abbyy.com/flexi-capture/api/methods/get-document2.md): GetDocument2 method in the ABBYY FlexiCapture Web Services API returns information about a document with an expanded set of fields.
- [GetDocumentResultsList](https://docs.abbyy.com/flexi-capture/get-document-results-list.md): GetDocumentResultsList in the ABBYY FlexiCapture web services API returns the files a document was exported into when results are stored on the server.
- [GetDocuments](https://docs.abbyy.com/flexi-capture/api/methods/get-documents.md): GetDocuments in the ABBYY FlexiCapture web services API returns a Document array describing every document in a batch, including the empty parent document.
- [GetDocuments2](https://docs.abbyy.com/flexi-capture/api/methods/get-documents2.md): GetDocuments2 method in the ABBYY FlexiCapture Web Services API returns a list of documents with an expanded set of fields.
- [LoadDocumentResult](https://docs.abbyy.com/flexi-capture/api/methods/load-document-result.md): LoadDocumentResult in the ABBYY FlexiCapture web services API downloads a File with the exported processing results of a document from the Application Server.
- [SetDocumentProperties](https://docs.abbyy.com/flexi-capture/api/methods/set-document-properties.md): SetDocumentProperties method in the ABBYY FlexiCapture web services API specifies the registration parameters of a document using RegistrationProperty records.
- [SetDocumentPriority](https://docs.abbyy.com/flexi-capture/api/methods/set-document-priority.md): SetDocumentPriority method in the ABBYY FlexiCapture web services API changes the processing priority of a document using a value from the Priority enumeration.
- [Pages](https://docs.abbyy.com/flexi-capture/api/methods/pages.md): Reference to the ABBYY FlexiCapture web services API methods for working with pages: add a page image to a document, delete a page, and replace a page image.
- [AddNewPage](https://docs.abbyy.com/flexi-capture/api/methods/add-new-page.md): AddNewPage method in the ABBYY FlexiCapture web services API adds a page image and its description to a document at a chosen position within the set.
- [AddNewPageEx](https://docs.abbyy.com/flexi-capture/api/methods/add-new-page-ex.md): Add a page image from a file to a FlexiCapture document with the AddNewPageEx Web Services API method.
- [DeletePage](https://docs.abbyy.com/flexi-capture/api/methods/delete-page.md): DeletePage method in the ABBYY FlexiCapture web services API removes a single page from a document by its page ID and returns a flag indicating success.
- [ReplacePageImage](https://docs.abbyy.com/flexi-capture/api/methods/replace-page-image.md): ReplacePageImage method in the ABBYY FlexiCapture web services API swaps the image of an existing page in a document with a new File supplied by the caller.
- [Users](https://docs.abbyy.com/flexi-capture/api/methods/users-api-methods.md): Reference to the ABBYY FlexiCapture web services API methods for working with user accounts: find users, list roles, check rights, and retrieve user statistics.
- [AddUserIfNotExist](https://docs.abbyy.com/flexi-capture/api/methods/add-user-if-not-exist.md): AddUserIfNotExist in the ABBYY FlexiCapture web services API returns the current user ID and creates a database record for the user if one does not exist.
- [FindUser](https://docs.abbyy.com/flexi-capture/api/methods/find-user.md): FindUser method in the ABBYY FlexiCapture web services API returns the integer user ID for a given user name, letting you look up an account by login.
- [GetAvailableUsers](https://docs.abbyy.com/flexi-capture/api/methods/get-available-users.md): GetAvailableUsers in the ABBYY FlexiCapture web services API lists the users or groups allowed to process a stage, so you can choose a recipient for a task.
- [GetProjectsForStationType](https://docs.abbyy.com/flexi-capture/get-projects-for-station-type.md): GetProjectsForStationType method in the ABBYY FlexiCapture web services API finds projects where a user holds at least one role tied to a given station type.
- [GetProjectsForUser](https://docs.abbyy.com/flexi-capture/api/methods/get-projects-for-user.md): Call GetProjectsForUser in the ABBYY FlexiCapture API to retrieve Application Server projects filtered by a user ID and role type access permissions.
- [GetRoles](https://docs.abbyy.com/flexi-capture/api/methods/get-roles.md): Use the GetRoles method in the ABBYY FlexiCapture API to return the full list of roles defined in a project, each as a Role record with its details.
- [GetUser](https://docs.abbyy.com/flexi-capture/api/methods/get-user.md): Call GetUser in the ABBYY FlexiCapture API to look up a user by ID and return a User object with account details, plus a flag showing whether it was found.
- [GetUserRoles](https://docs.abbyy.com/flexi-capture/api/methods/get-user-roles.md): Use GetUserRoles in the ABBYY FlexiCapture API to get the IDs of the roles available to the current user within a specified project.
- [GetUsers](https://docs.abbyy.com/flexi-capture/api/methods/get-users.md): Call the GetUsers method in the ABBYY FlexiCapture API to retrieve the complete list of users as an array of User objects from the Application Server.
- [GetUserStatistics](https://docs.abbyy.com/flexi-capture/api/methods/get-user-statistics.md): Call GetUserStatistics in the ABBYY FlexiCapture API to count the batches, documents, and pages a user processed within a given date range.
- [Licensing tickets](https://docs.abbyy.com/flexi-capture/api/methods/tickets.md): Browse the ABBYY FlexiCapture API methods for licensing tickets, covering how to obtain, update, and release tickets for connected workstations.
- [GetNewTicket](https://docs.abbyy.com/flexi-capture/api/methods/get-new-ticket.md): Use GetNewTicket in the ABBYY FlexiCapture API to obtain a licensing ticket for a session and station type, returned as a TicketInfo object.
- [ReleaseTicket](https://docs.abbyy.com/flexi-capture/api/methods/release-ticket.md): Call ReleaseTicket in the ABBYY FlexiCapture API to release a licensing ticket by session and ticket ID, freeing the license for reuse.
- [UpdateTicket](https://docs.abbyy.com/flexi-capture/api/methods/update-ticket.md): Use UpdateTicket in the ABBYY FlexiCapture API to refresh the status of a licensing ticket and return the updated TicketInfo object.
- [Files](https://docs.abbyy.com/flexi-capture/api/methods/files-api-methods.md): Browse the ABBYY FlexiCapture API methods for user files, covering how to list, load, save, and remove custom files stored on the Application Server.
- [GetCustomFileNames](https://docs.abbyy.com/flexi-capture/api/methods/get-custom-file-names.md): Call GetCustomFileNames in the ABBYY FlexiCapture API to retrieve the list of user file names currently saved on the Application Server.
- [LoadCustomFile](https://docs.abbyy.com/flexi-capture/api/methods/load-custom-file.md): Use LoadCustomFile in the ABBYY FlexiCapture API to retrieve a user file by name from the Application Server, returned as a File object.
- [RemoveCustomFile](https://docs.abbyy.com/flexi-capture/api/methods/remove-custom-file.md): Call RemoveCustomFile in the ABBYY FlexiCapture API to delete a user file by name from the Application Server within a given session.
- [SaveCustomFile](https://docs.abbyy.com/flexi-capture/api/methods/save-custom-file.md): Use SaveCustomFile in the ABBYY FlexiCapture API to store a user file on the Application Server by passing a File object within an active session.
- [Attachments](https://docs.abbyy.com/flexi-capture/api/methods/attachments.md): Browse the ABBYY FlexiCapture API methods for attachments, covering how to list, load, save, and delete attachments on the Application Server.
- [GetAttachmentNames](https://docs.abbyy.com/flexi-capture/api/methods/get-attachment-names.md): Call GetAttachmentNames in the ABBYY FlexiCapture API to list the attachments of a given type for a document, page, or batch object.
- [LoadAttachment](https://docs.abbyy.com/flexi-capture/api/methods/load-attachment.md): Use LoadAttachment in the ABBYY FlexiCapture API to download an attachment from a document, page, or batch as a File object, with a default 100 MB limit.
- [RemoveAttachment](https://docs.abbyy.com/flexi-capture/api/methods/remove-attachment.md): Call RemoveAttachment in the ABBYY FlexiCapture API to delete an attachment by name from a document, page, or batch on the Application Server.
- [SaveAttachment](https://docs.abbyy.com/flexi-capture/api/methods/save-attachment.md): Use SaveAttachment in the ABBYY FlexiCapture API to add an attachment File to a specified document, page, or batch object on the Application Server.
- [Templates](https://docs.abbyy.com/flexi-capture/api/methods/templates.md): Browse the ABBYY FlexiCapture API methods for Document Definitions, covering how to get a project set and the definitions attached to a batch type.
- [GetTemplates](https://docs.abbyy.com/flexi-capture/api/methods/get-templates.md): Call GetTemplates in the ABBYY FlexiCapture API to retrieve information about all Document Definitions in a project as an array of Template records.
- [GetBatchTypeTemplates](https://docs.abbyy.com/flexi-capture/api/methods/get-batch-type-templates.md): Use GetBatchTypeTemplates in the ABBYY FlexiCapture API to return the IDs of Document Definitions attached to a specific batch type in a project.
- [Log](https://docs.abbyy.com/flexi-capture/api/methods/logs.md): Browse the ABBYY FlexiCapture API methods for the event log, including WriteToLog for recording event data in the log on the Application Server.
- [WriteToLog](https://docs.abbyy.com/flexi-capture/api/methods/write-to-log.md): Call WriteToLog in the ABBYY FlexiCapture API to record a set of LogRecord events in the Application Server log, with client time for accurate timestamps.
- [Server Requests](https://docs.abbyy.com/flexi-capture/api/methods/server-requests.md): Server request methods in the ABBYY FlexiCapture Web Services API: create, delete, list, and read or change the status of Application Server requests.
- [CreateRequest](https://docs.abbyy.com/flexi-capture/api/methods/create-request-api-methods.md): CreateRequest method in the ABBYY FlexiCapture Web Services API: submits a ServerRequest to the Application Server and returns the new request ID as an int.
- [DeleteRequest](https://docs.abbyy.com/flexi-capture/api/methods/delete-request.md): DeleteRequest method in the ABBYY FlexiCapture Web Services API: removes an Application Server request by its request ID and session ID.
- [GetRequests](https://docs.abbyy.com/flexi-capture/api/methods/get-requests.md): GetRequests method in the ABBYY FlexiCapture Web Services API: returns the array of Application Server requests for a batch and task in the current session.
- [GetRequestStatus](https://docs.abbyy.com/flexi-capture/api/methods/get-request-status.md): GetRequestStatus method in the ABBYY FlexiCapture Web Services API: returns the current status of an Application Server request as a ServerRequestStatus value.
- [SetRequestStatus](https://docs.abbyy.com/flexi-capture/api/methods/set-request-status.md): SetRequestStatus method in the ABBYY FlexiCapture Web Services API: updates the status of an Application Server request using a ServerRequestStatus value.
- [Other](https://docs.abbyy.com/flexi-capture/api/methods/other.md): Other ABBYY FlexiCapture Web Services API methods for reading and saving named settings in the database with GetSettingValue and SetSettingValue.
- [GetSettingValue](https://docs.abbyy.com/flexi-capture/api/methods/get-setting-value.md): GetSettingValue method in the ABBYY FlexiCapture Web Services API: reads a named parameter from the database by user, project, and batch type.
- [SetSettingValue](https://docs.abbyy.com/flexi-capture/api/methods/set-setting-value.md): SetSettingValue method in the ABBYY FlexiCapture Web Services API: saves a named parameter to the database per user, project, and batch type.
- [Data types](https://docs.abbyy.com/flexi-capture/api/structures/structures.md): Reference for the data types used by ABBYY FlexiCapture Web Services API methods, including Batch, Document, File, Role, Task, Template, User, and more.
- [Batch](https://docs.abbyy.com/flexi-capture/api/structures/batch-api-structures.md): Batch data type in the ABBYY FlexiCapture Web Services API: holds batch details like ID, name, type, priority, document counts, and processing statistics.
- [DetailedBatch](https://docs.abbyy.com/flexi-capture/api/structures/detailed-batch.md): DetailedBatch data type in the ABBYY FlexiCapture Web Services API: extended batch information including document counts, priority, and creation date.
- [DetailedBatch2](https://docs.abbyy.com/flexi-capture/api/structures/detailed-batch2.md): DetailedBatch2 data type in the ABBYY FlexiCapture Web Services API: expanded batch fields including counts, priority, attachments, error text, and owner.
- [BatchType](https://docs.abbyy.com/flexi-capture/api/structures/batch-type-api-structures.md): BatchType data type in the ABBYY FlexiCapture Web Services API: stores batch type details including ID, name, and registration parameter definitions.
- [BatchTypeIdentity](https://docs.abbyy.com/flexi-capture/api/structures/batch-type-identity.md): BatchTypeIdentity data type in the ABBYY FlexiCapture Web Services API: identifies a batch type by ID and project so you can list batch types across projects.
- [ChildrenOrder](https://docs.abbyy.com/flexi-capture/api/structures/children-order.md): ChildrenOrder data type in the ABBYY FlexiCapture Web Services API: holds a child document ID and its sort index to order documents within a set.
- [Document](https://docs.abbyy.com/flexi-capture/api/structures/document.md): Document data type in the ABBYY FlexiCapture Web Services API: holds document details like ID, batch, pages, processing stage, status flags, and errors.
- [DocumentEx](https://docs.abbyy.com/flexi-capture/api/structures/document-ex.md): DocumentEx data type in the ABBYY FlexiCapture Web Services API: extended document information including pages, processing status, errors, and priority.
- [Document2](https://docs.abbyy.com/flexi-capture/api/structures/document2.md): Document2 data type in the ABBYY FlexiCapture Web Services API: expanded document fields including pages, counts, status flags, errors, and priority.
- [File](https://docs.abbyy.com/flexi-capture/api/structures/file.md): File data type in the ABBYY FlexiCapture Web Services API: stores a file as a name string and its binary contents in a byte array for transfer through the API.
- [LicenseCustomFeature](https://docs.abbyy.com/flexi-capture/api/structures/license-custom-feature.md): LicenseCustomFeature data type in the ABBYY FlexiCapture Web Services API: holds the name and value of a custom parameter defined in the product license.
- [LogRecord](https://docs.abbyy.com/flexi-capture/api/structures/log-record.md): LogRecord data type in the ABBYY FlexiCapture Web Services API: stores an event log entry with its type, session, role, project, batch, document, and timestamp.
- [Page](https://docs.abbyy.com/flexi-capture/api/structures/page.md): Page data type in the ABBYY FlexiCapture Web Services API: fields that describe a document page, its image source, character counts, and status flags.
- [PageEx](https://docs.abbyy.com/flexi-capture/api/structures/page-ex.md): PageEx data type in the ABBYY FlexiCapture Web Services API: extended page information including source file, source page number, and error text.
- [Page2](https://docs.abbyy.com/flexi-capture/api/structures/page2.md): Page2 data type in the ABBYY FlexiCapture Web Services API: expanded page fields including source type, character counts, file version, and status flags.
- [ProcessingStage](https://docs.abbyy.com/flexi-capture/api/structures/processing-stage.md): ProcessingStage data type in the ABBYY FlexiCapture Web Services API: fields that identify a processing stage, its project, batch type, and stage type.
- [ProcessingStageExt](https://docs.abbyy.com/flexi-capture/api/structures/processing-stages-ext.md): ProcessingStageExt data type in the ABBYY FlexiCapture Web Services API: extended processing stage information such as ID, project, batch type, and name.
- [Project](https://docs.abbyy.com/flexi-capture/api/structures/project.md): Project data type in the ABBYY FlexiCapture Web Services API: fields describing a project on the Application Server, including ID, name, GUID, and test flag.
- [Queue](https://docs.abbyy.com/flexi-capture/api/structures/queue.md): Queue data type in the ABBYY FlexiCapture Web Services API: fields describing the document queue at a processing stage, including task counts and stage type.
- [RegistrationProperty](https://docs.abbyy.com/flexi-capture/api/structures/registration-property.md): RegistrationProperty data type in the ABBYY FlexiCapture Web Services API: the name and value fields of a batch or document registration parameter.
- [RegistrationPropertyDef](https://docs.abbyy.com/flexi-capture/api/structures/registration-property-def.md): RegistrationPropertyDef data type in the ABBYY FlexiCapture Web Services API: fields defining a batch type registration parameter and whether it is required.
- [Role](https://docs.abbyy.com/flexi-capture/api/structures/role-api-structures.md): Role data type in the ABBYY FlexiCapture Web Services API: fields describing a user role, its type, project, and the bit-flag set of role attributes.
- [ServerRequest](https://docs.abbyy.com/flexi-capture/api/structures/server-request.md): ServerRequest data type in the ABBYY FlexiCapture Web Services API: fields describing a request to run validation rules on the Application Server.
- [Task](https://docs.abbyy.com/flexi-capture/api/structures/task.md): Task data type in the ABBYY FlexiCapture Web Services API: fields describing a task, its batch, status, priority, timestamps, assigned user, and flags.
- [TaskDocument](https://docs.abbyy.com/flexi-capture/api/structures/task-document.md): TaskDocument data type in the ABBYY FlexiCapture Web Services API: document fields for a task including flags, errors, pages, and character counts.
- [TaskDocumentList](https://docs.abbyy.com/flexi-capture/api/structures/task-document-list.md): TaskDocumentList data type in the ABBYY FlexiCapture Web Services API: holds the array of documents in a task and their count.
- [TaskExt](https://docs.abbyy.com/flexi-capture/api/structures/task-ext.md): TaskExt data type in the ABBYY FlexiCapture Web Services API: extended task fields including batch, status, priority, timestamps, creator, and flags.
- [TaskList](https://docs.abbyy.com/flexi-capture/api/structures/task-list.md): TaskList data type in the ABBYY FlexiCapture Web Services API: holds the array of task records and their count.
- [TaskListExt](https://docs.abbyy.com/flexi-capture/api/structures/task-list-ext.md): TaskListExt data type in the ABBYY FlexiCapture Web Services API: holds the array of extended task records and their count.
- [TaskPage](https://docs.abbyy.com/flexi-capture/api/structures/task-page.md): TaskPage data type in the ABBYY FlexiCapture Web Services API: fields describing a page in a task, its image source, flags, and character counts.
- [Template](https://docs.abbyy.com/flexi-capture/api/structures/template.md): Template data type in the ABBYY FlexiCapture Web Services API: fields describing a Document Definition, including its ID, name, version, and disabled state.
- [TicketInfo](https://docs.abbyy.com/flexi-capture/api/structures/ticket-info.md): TicketInfo data type in the ABBYY FlexiCapture Web Services API: fields describing a licensing ticket, including license number, station type, and expiration.
- [User](https://docs.abbyy.com/flexi-capture/api/structures/user.md): Reference for the User data type in the ABBYY FlexiCapture Web Services API: the ID, name, and full name fields that identify a user in the system.
- [UserList](https://docs.abbyy.com/flexi-capture/api/structures/user-list.md): UserList data type in the ABBYY FlexiCapture Web Services API: holds the array of user records and their count.
- [UserStatistics](https://docs.abbyy.com/flexi-capture/api/structures/user-statistics.md): Reference for the UserStatistics data type in the ABBYY FlexiCapture Web Services API: counts of batches, documents, and pages a user has processed at a stage.
- [Enumerations](https://docs.abbyy.com/flexi-capture/api/structures/enumerators-api-structures.md): Enumerations used in the ABBYY FlexiCapture Application Server Web Services API, covering log record types, priority, processing stage, role, and station types.
- [LogRecordType](https://docs.abbyy.com/flexi-capture/api/structures/t-log-record-type.md): LogRecordType enumeration in the ABBYY FlexiCapture Web Services API: defines the event types to log as Error, Warning, or Information messages.
- [ProcessingPriority](https://docs.abbyy.com/flexi-capture/api/structures/t-priority.md): Priority enumeration in the ABBYY FlexiCapture Web Services API: lists processing priority values for batches, documents, and tasks from Lowest to Extra-High.
- [ProcessingStage](https://docs.abbyy.com/flexi-capture/api/structures/t-processing-stage-type.md): ProcessingStage enumeration in the ABBYY FlexiCapture Web Services API: lists predefined processing stage types from Scanning and Recognition through Export.
- [RoleType](https://docs.abbyy.com/flexi-capture/api/structures/t-role-type.md): RoleType enumeration in the ABBYY FlexiCapture Web Services API lists predefined user roles such as Scanning Operator, Verification Operator, and Admin.
- [ServerRequestStatus](https://docs.abbyy.com/flexi-capture/api/structures/server-request-status.md): ServerRequestStatus enumeration in the ABBYY FlexiCapture Web Services API: defines validation-rule request states such as Pending, InProcess, and Completed.
- [WorkstationType](https://docs.abbyy.com/flexi-capture/api/structures/t-workstation-type.md): WorkstationType enumeration in the ABBYY FlexiCapture Web Services API: lists predefined station types such as Scanning, Verification, and Web stations.
- [Exchange files with the Application Server](https://docs.abbyy.com/flexi-capture/api/files/files.md): Exchange files with the ABBYY FlexiCapture Application Server using POST requests: load, save, append, and checksum images, attachments, and XML data.
- [File service POST request examples](https://docs.abbyy.com/flexi-capture/api/files/examples-api-files.md): C# POST request examples for the ABBYY FlexiCapture file service: load files from the server, upload files, get a checksum, and modify a file in parts.
- [Web Services Mobile API](https://docs.abbyy.com/flexi-capture/mobile-api.md): Build mobile clients for ABBYY FlexiCapture with the Web Services Mobile API: request parameters, upload files, and authenticate with a Bearer ticket.
- [Request the parameters](https://docs.abbyy.com/flexi-capture/parameter-request.md): Send a GET request to the ABBYY FlexiCapture Mobile API to retrieve available projects, batch types, and registration parameters as JSON for mobile clients.
- [Upload files to the server](https://docs.abbyy.com/flexi-capture/post-put-request.md): Upload images to the ABBYY FlexiCapture server through the Mobile API using PUT or POST requests, with MD5 hash verification and multipart support.
- [Specify the structure of a batch](https://docs.abbyy.com/flexi-capture/package-structure.md): Describe a batch structure when sending pages to the ABBYY FlexiCapture server via POST: build documents, set a Document Definition, and add parameters.
- [Web Services for user account management](https://docs.abbyy.com/flexi-capture/group-user-management-api.md): Automate user accounts, groups, and permissions in ABBYY FlexiCapture with the AuthAPI web service, accessed through its SOAP endpoint and WSDL.
- [Data types](https://docs.abbyy.com/flexi-capture/man-datatypes.md): Overview of the data types used by the ABBYY FlexiCapture user account management web service, covering UserInfo, GroupInfo, TenantInfo, and permission records.
- [UserInfo](https://docs.abbyy.com/flexi-capture/man-user-info.md): UserInfo data type in the ABBYY FlexiCapture user management API: database record fields with a user ID, name, full name, email, and tenant ID.
- [GroupInfo](https://docs.abbyy.com/flexi-capture/man-group-info.md): GroupInfo data type in the ABBYY FlexiCapture user management API: database record fields with a group ID, short name, full name, and tenant ID.
- [TenantInfo](https://docs.abbyy.com/flexi-capture/man-tenant-info.md): TenantInfo data type in the ABBYY FlexiCapture user management API: database record fields with a tenant ID, name, description, and license settings.
- [RolePermissionInfo](https://docs.abbyy.com/flexi-capture/role-permission-info.md): RolePermissionInfo data type in the ABBYY FlexiCapture user management API: fields defining permission to use a role by batch type, project, and role type.
- [PermissionRequestInfo](https://docs.abbyy.com/flexi-capture/permission-request-info.md): Reference for the PermissionRequestInfo data type in the ABBYY FlexiCapture API, describing fields that report a permission request sent to an administrator.
- [Methods](https://docs.abbyy.com/flexi-capture/man-methods.md): Overview of the ABBYY FlexiCapture web services API methods for managing users, groups, tenants, and permissions, including IsDatabaseConnected.
- [IsDatabaseConnected](https://docs.abbyy.com/flexi-capture/is-database-connected.md): IsDatabaseConnected method in the ABBYY FlexiCapture API checks whether the database is connected to the Application Server and returns a bool value.
- [Manage users](https://docs.abbyy.com/flexi-capture/man-users.md): ABBYY FlexiCapture user management API methods to create, find, update, and delete users, change or reset passwords, and validate credentials.
- [ChangePassword](https://docs.abbyy.com/flexi-capture/change-password.md): ChangePassword method in the ABBYY FlexiCapture user management API resets a user password, with sample code for computing the salted SHA-256 password hash.
- [CreateUser](https://docs.abbyy.com/flexi-capture/create-user.md): CreateUser method in the ABBYY FlexiCapture user management API creates a user from name, password hash, email, and tenant, and returns the new user ID.
- [DeleteUser](https://docs.abbyy.com/flexi-capture/delete-user.md): DeleteUser method in the ABBYY FlexiCapture user management API removes a user from the system by user ID, taking a single userId parameter and no return.
- [FindUser](https://docs.abbyy.com/flexi-capture/find-user2.md): FindUser method in the ABBYY FlexiCapture user management API searches for a user by user name and returns the matching user ID as an integer value.
- [GetUser](https://docs.abbyy.com/flexi-capture/get-user2.md): GetUser method in the ABBYY FlexiCapture user management API retrieves a UserInfo object with account details for a given user name.
- [UpdateUser](https://docs.abbyy.com/flexi-capture/update-user.md): UpdateUser method in the ABBYY FlexiCapture user management API updates a user name, full name, and email for an existing user identified by user ID.
- [UserNeedToResetPassword](https://docs.abbyy.com/flexi-capture/user-need-to-reset-password.md): UserNeedToResetPassword method in the ABBYY FlexiCapture user management API checks whether a given user must change their password and returns a bool.
- [ValidateUser](https://docs.abbyy.com/flexi-capture/validate-user.md): ValidateUser method in the ABBYY FlexiCapture user management API verifies that a user name and password hash match stored credentials, with hashing sample.
- [Manage groups](https://docs.abbyy.com/flexi-capture/man-groups.md): ABBYY FlexiCapture group management API methods to create and delete groups, add or remove members, and request group, child group, and member information.
- [AddToGroup](https://docs.abbyy.com/flexi-capture/add-to-group.md): AddToGroup method in the ABBYY FlexiCapture group management API adds a user or nested group to a specified group using principal and group IDs.
- [CreateGroup](https://docs.abbyy.com/flexi-capture/create-group.md): CreateGroup method in the ABBYY FlexiCapture group management API creates a new group from a short name and full name and returns the new group ID.
- [DeleteGroup](https://docs.abbyy.com/flexi-capture/delete-group.md): DeleteGroup method in the ABBYY FlexiCapture group management API removes a group by group ID, taking a single groupId parameter and returning no value.
- [GetChildGroups](https://docs.abbyy.com/flexi-capture/get-child-groups.md): GetChildGroups method in the ABBYY FlexiCapture group management API returns a GroupInfo array describing every group nested within a specified parent group.
- [GetGroup](https://docs.abbyy.com/flexi-capture/get-group.md): GetGroup method in the ABBYY FlexiCapture group management API retrieves a GroupInfo record for a group ID and returns a bool for whether the group exists.
- [GetGroups](https://docs.abbyy.com/flexi-capture/get-groups.md): GetGroups method in the ABBYY FlexiCapture group management API returns a GroupInfo array with information about every group defined in the system.
- [GetUsersInGroup](https://docs.abbyy.com/flexi-capture/get-users-in-groups.md): GetUsersInGroup method in the ABBYY FlexiCapture group management API returns a UserInfo array listing every user that belongs to a specified group.
- [RemoveFromGroup](https://docs.abbyy.com/flexi-capture/remove-from-group.md): RemoveFromGroup method in the ABBYY FlexiCapture group management API removes a user or nested group from a specified group using principal and group IDs.
- [Manage tenants](https://docs.abbyy.com/flexi-capture/man-tenants.md): ABBYY FlexiCapture tenant management API methods to add, delete, find, and update tenants and obtain information about all tenants in a multi-tenant deployment.
- [AddTenant](https://docs.abbyy.com/flexi-capture/add-tenant.md): AddTenant method in the ABBYY FlexiCapture tenant management API creates a tenant with name, description, and license settings, returning the tenant ID.
- [DeleteTenant](https://docs.abbyy.com/flexi-capture/delete-tenant.md): DeleteTenant method in the ABBYY FlexiCapture tenant management API removes a tenant from the system by tenant ID, taking a single tenantId parameter.
- [FindTenant](https://docs.abbyy.com/flexi-capture/find-tenant.md): FindTenant method in the ABBYY FlexiCapture tenant management API searches for a tenant by name and returns the matching tenant ID as an integer value.
- [GetTenants](https://docs.abbyy.com/flexi-capture/get-tenants.md): GetTenants method in the ABBYY FlexiCapture web services API: returns an array of TenantInfo objects with details about every tenant configured on the server.
- [UpdateTenant](https://docs.abbyy.com/flexi-capture/update-tenant.md): UpdateTenant method in the ABBYY FlexiCapture web services API: changes a tenant name, description, license number, and common-license sharing by tenant ID.
- [Manage permissions](https://docs.abbyy.com/flexi-capture/man-permissions.md): Web services API methods for managing FlexiCapture permissions: add, check, and remove role permissions for users, groups, and tenants and handle requests.
- [AddPermission](https://docs.abbyy.com/flexi-capture/add-permission.md): AddPermission method in the ABBYY FlexiCapture web services API: grants a user or group permission to use a specified role in a given project and batch type.
- [CreatePermissionRequest](https://docs.abbyy.com/flexi-capture/create-permission-request.md): CreatePermissionRequest method in the ABBYY FlexiCapture web services API submits a permission request from a named user and returns whether the user exists.
- [GetUserPermissions](https://docs.abbyy.com/flexi-capture/get-user-permissions.md): GetUserPermissions method in the ABBYY FlexiCapture web services API returns RolePermissionInfo objects for every role permission granted to a named user.
- [GetUserRequests](https://docs.abbyy.com/flexi-capture/get-user-requests.md): GetUserRequests method in the ABBYY FlexiCapture web services API: returns PermissionRequestInfo objects for the permission requests sent by a named user.
- [GetWhiteIPList](https://docs.abbyy.com/flexi-capture/get-white-ip-list.md): GetWhiteIPList method in the ABBYY FlexiCapture web services API: returns the allowlist of IP addresses permitted to access a tenant by its tenant ID.
- [HasPermission](https://docs.abbyy.com/flexi-capture/has-permission.md): HasPermission method in the ABBYY FlexiCapture web services API checks whether a user or group holds a given role in a project and returns true or false.
- [RemovePermission](https://docs.abbyy.com/flexi-capture/remove-permission.md): RemovePermission method in the ABBYY FlexiCapture web services API revokes a user or group permission to use a role in a given project and batch type.
- [Download reports with the Web API](https://docs.abbyy.com/flexi-capture/api/reports/using-web-api-for-reports.md): Download ABBYY FlexiCapture reports on operator workload, processing performance, and license consumption as CSV through the Web API GetCsv GET request.
- [General Operator reports](https://docs.abbyy.com/flexi-capture/api/reports/api-reports-operator.md): Web API parameters for the ABBYY FlexiCapture General Operators report, which measures operator productivity at manual processing stages, with a JSON example.
- [Processing Performance reports](https://docs.abbyy.com/flexi-capture/api/reports/api-reports-processing.md): Web API parameters for the ABBYY FlexiCapture Processing Performance report, measuring throughput across projects, batch types, and stages, with JSON example.
- [Site Performance reports](https://docs.abbyy.com/flexi-capture/api/reports/api-reports-performance.md): Web API parameters for the ABBYY FlexiCapture Site Performance report, which assesses overall site and per-tenant performance, with a JSON request example.
- [License consumption by tenants](https://docs.abbyy.com/flexi-capture/api/reports/api-reports-consumptionbytenants.md): Web API parameters for the ABBYY FlexiCapture License Consumption by Tenants report, showing pages consumed per tenant by Processing Stations, with JSON.
- [License consumption by projects](https://docs.abbyy.com/flexi-capture/api/reports/api-reports-consumptionbyprojects.md): Web API parameters for the ABBYY FlexiCapture License Consumption by Projects report, showing pages consumed per project by Processing Stations, with JSON.
- [Download logs with the Web API](https://docs.abbyy.com/flexi-capture/api/logs/using-web-api-for-logs.md): Download ABBYY FlexiCapture event logs and security event logs from System Monitor and Processing Monitor as CSV files through the Web API.
- [Event log from System Monitor](https://docs.abbyy.com/flexi-capture/api/logs/api-eventlog-systemmonitor.md): Download the ABBYY FlexiCapture System Monitor event log as CSV via the GetEventsCSV POST request, with filter, column, sort, and tenant parameters.
- [Event log from Processing Monitor](https://docs.abbyy.com/flexi-capture/api/logs/api-eventlog-processingmonitor.md): Download the ABBYY FlexiCapture Processing Monitor event log of document processing events as CSV via the GetEventsCSV POST request, with a script example.
- [Security event log from System Monitor](https://docs.abbyy.com/flexi-capture/api/logs/api-security-eventlog-systemmonitor.md): Download the ABBYY FlexiCapture System Monitor security event log of permission changes as CSV via the GetSecurityEventsCSV POST request, with a script.
- [Security event log from Processing Monitor](https://docs.abbyy.com/flexi-capture/api/logs/api-security-eventlog-processingmonitor.md): Download the ABBYY FlexiCapture Processing Monitor security event log of permission changes as CSV via the GetSecurityEventsCSV POST request, with a script.
- [API usage examples](https://docs.abbyy.com/flexi-capture/api/examples/examples-api-examples.md): Worked ABBYY FlexiCapture web services API examples covering automatic batch processing of bank applications and adding a custom manual data-processing stage.
- [Example of automatic processing](https://docs.abbyy.com/flexi-capture/unattended-example.md): Walk through an ABBYY FlexiCapture API example that opens a session, creates a batch, uploads bank application images, processes them, and reads results.
- [Example of manual processing](https://docs.abbyy.com/flexi-capture/user-service-step.md): Walk through an ABBYY FlexiCapture API example that adds a custom service stage to review tasks, accept or reject documents, and attach a digital signature.

## Integrate Web Stations into third-party systems

- [Integrate Web Stations into third-party systems](https://docs.abbyy.com/flexi-capture/fc-integration.md): Embed ABBYY FlexiCapture 12 Verification and Scanning stages into third-party systems such as SharePoint using an iframe element and Single Sign-On.
- [Integrate the verification stage](https://docs.abbyy.com/flexi-capture/verification-integration.md): Embed the ABBYY FlexiCapture Web Verification Station in a third-party system via an iframe, passing project, role, stage, task, and language URL parameters.
- [Integrate the scanning stage](https://docs.abbyy.com/flexi-capture/scanning-integration.md): Embed the ABBYY FlexiCapture Web Scanning Station in a third-party system via an iframe to create, open, or rescan batches using Manage URL commands.
- [iframe restrictions](https://docs.abbyy.com/flexi-capture/i-frame-restrictions.md): Work around SameSite cookie restrictions that block ABBYY FlexiCapture in an iframe over HTTP, by enabling SameSite by default in Chrome and Edge.

## Configure additional settings and customize Web Stations

- [Configure additional settings and customize Web Stations](https://docs.abbyy.com/flexi-capture/web-settings-customization.md): Customize the appearance and transitions of ABBYY FlexiCapture 12 Web Stations and tune settings, with links to customization and web.config key references.
- [Change the interface language](https://docs.abbyy.com/flexi-capture/web-stations-ui-language.md): Change the default interface language of ABBYY FlexiCapture Web Stations through the Fine Objects registry key, with the full list of supported language values.
- [Customize Web Stations](https://docs.abbyy.com/flexi-capture/web-customization.md): Tailor ABBYY FlexiCapture Web Stations through the customization view: change the logo, header, footer, icon, links, languages, and session lifetime.
- [Customization settings](https://docs.abbyy.com/flexi-capture/customization-settings.md): Locate the customization template and content files for ABBYY FlexiCapture Web Stations, including Index.cshtml, Custom.css, Custom.js, Icon.ico, and Logo.png.
- [Web.config keys for Web Stations](https://docs.abbyy.com/flexi-capture/webconfig-keys.md): Reference of web.config appSettings keys for tuning ABBYY FlexiCapture Web Stations, covering the Login Page, Verification, Scanning, and Monitoring Console.

## Custom reports

- [About ABBYY FlexiCapture Custom Reports](https://docs.abbyy.com/flexi-capture/reports/overview/overview-reports-overview.md): Custom reports gather user-defined statistics to monitor ABBYY FlexiCapture and analyze workflow, built in Visual Studio, Report Builder, or Crystal Reports.
- [Changes to the FlexiCapture database](https://docs.abbyy.com/flexi-capture/reports/overview/whatsnew-reports-overview.md): Summary of changes to the ABBYY FlexiCapture reporting database: the new BatchItem, StatisticConnections, Tenant, and EditSession tables and added SLA columns.
- [Purpose of custom reports](https://docs.abbyy.com/flexi-capture/reports/overview/facilities.md): Custom reports select and analyze data for standard reports in the ABBYY FlexiCapture Administration and Monitoring Console, built by users, run by operators.
- [Enable custom reports](https://docs.abbyy.com/flexi-capture/reports/overview/connection.md): Enable a custom report in ABBYY FlexiCapture by placing its rdlc or rdl and XML files in the CustomReports folder, and then activating it from Monitoring Console.
- [Launch custom reports](https://docs.abbyy.com/flexi-capture/reports/overview/running.md): Launch custom reports from the Custom reports menu of the ABBYY FlexiCapture Administration and Monitoring Console, supplying missing parameters if prompted.
- [Create custom reports](https://docs.abbyy.com/flexi-capture/reports/development/development.md): Build ABBYY FlexiCapture custom reports for Microsoft Report Viewer using data sets, XML description files, and tips for optimizing query speed and report size.
- [Create a custom report](https://docs.abbyy.com/flexi-capture/reports/development/creating-data-set.md): Step-by-step instructions for building an ABBYY FlexiCapture custom report in Microsoft Visual Studio or Report Builder using a RepDataSet data set.
- [XML description file](https://docs.abbyy.com/flexi-capture/reports/development/xml-file.md): Reference for the XML description file enabling a custom report in ABBYY FlexiCapture, covering the customreport, sqlText, parameter, and possiblevaluelist.
- [Database structure](https://docs.abbyy.com/flexi-capture/reports/database/database-structure.md): Map of the ABBYY FlexiCapture database tables and their relationships, grouped by objects, workflow, statistics, access control, event log, and dictionaries.
- [Processing of objects](https://docs.abbyy.com/flexi-capture/reports/database/objects-reports-database.md): Relationship diagram and table index for ABBYY FlexiCapture processing objects, including Batch, BatchItem, BatchType, Project, Template, and TemplateVersion.
- [Batch](https://docs.abbyy.com/flexi-capture/reports/database/batch.md): Column reference for the Batch table in the ABBYY FlexiCapture database, listing document counts, priority, processing stage, status, and SLA fields.
- [BatchItem](https://docs.abbyy.com/flexi-capture/reports/database/batch-item.md): Column reference for the BatchItem table in the ABBYY FlexiCapture database, which stores the objects making up a batch, including documents and pages.
- [BatchParameter](https://docs.abbyy.com/flexi-capture/reports/database/batch-parameter.md): Column reference for the BatchParameter table in the ABBYY FlexiCapture database, which holds the registration parameters of batches and documents.
- [BatchType](https://docs.abbyy.com/flexi-capture/reports/database/batch-type.md): Column reference for the BatchType table in the ABBYY FlexiCapture database, listing batch types with their name, project, file version, and SLA fields.
- [BatchTypeParameter](https://docs.abbyy.com/flexi-capture/reports/database/batch-type-parameter.md): Column reference for the BatchTypeParameter table in the ABBYY FlexiCapture database, which defines the registration parameters available for each batch type.
- [BatchTypeTemplate](https://docs.abbyy.com/flexi-capture/reports/database/batch-type-template.md): Column reference for the BatchTypeTemplate table in the ABBYY FlexiCapture database, which links batch types to the Document Definitions they may use.
- [DocumentSourceImage](https://docs.abbyy.com/flexi-capture/reports/database/document-source-image.md): Reference for the DocumentSourceImage table in the ABBYY FlexiCapture reports database: columns linking image file shortcuts to batch documents.
- [Project](https://docs.abbyy.com/flexi-capture/reports/database/project-reports-database.md): Reference for the Project table in the ABBYY FlexiCapture reports database: columns describing each project, its GUID, hot folders, SLA limits, and tenant.
- [Template](https://docs.abbyy.com/flexi-capture/reports/database/template-reports-database.md): Reference for the Template table in the ABBYY FlexiCapture reports database: columns listing Document Definitions, their GUID, project, and status flags.
- [TemplateVersion](https://docs.abbyy.com/flexi-capture/reports/database/template-version.md): Reference for the TemplateVersion table in the ABBYY FlexiCapture reports database: columns tracking Document Definition versions and file modifications.
- [Locks](https://docs.abbyy.com/flexi-capture/reports/database/locks.md): Map of the lock tables in the ABBYY FlexiCapture reports database, with a relationship diagram linking the EditSession, Lock, Session, and TemplateLock tables.
- [EditSession](https://docs.abbyy.com/flexi-capture/reports/database/edit-session.md): Reference for the EditSession table in the ABBYY FlexiCapture reports database: columns storing each batch object editing session, its batch, and task.
- [Lock](https://docs.abbyy.com/flexi-capture/reports/database/lock.md): Reference for the Lock table in the ABBYY FlexiCapture reports database: columns describing locked objects, their type, owning session, and synchronization.
- [Session](https://docs.abbyy.com/flexi-capture/reports/database/session.md): Reference for the Session table in the ABBYY FlexiCapture reports database: columns tracking active user work sessions, current tasks, roles, and timeouts.
- [TemplateLock](https://docs.abbyy.com/flexi-capture/reports/database/template-lock.md): Reference for the TemplateLock table in the ABBYY FlexiCapture reports database: columns recording which Document Definitions are open for editing and by whom.
- [Routing](https://docs.abbyy.com/flexi-capture/reports/database/routing.md): Map of the routing tables in the ABBYY FlexiCapture reports database, with a relationship diagram linking the ProcessingStage and Task tables.
- [ProcessingStage](https://docs.abbyy.com/flexi-capture/reports/database/processing-stage-reports-database.md): Reference for the ProcessingStage table in the ABBYY FlexiCapture reports database: columns defining workflow stages, their order, type, and batch settings.
- [Task](https://docs.abbyy.com/flexi-capture/reports/database/task-reports-database.md): Reference for the Task table in the ABBYY FlexiCapture reports database: columns describing each processing task, its stage, status, and assigned user.
- [Access control](https://docs.abbyy.com/flexi-capture/reports/database/users-reports-database.md): Map of the access control tables in the ABBYY FlexiCapture reports database, linking the Principal, PrincipalLink, PrincipalPermission, and Tenant tables.
- [Principal](https://docs.abbyy.com/flexi-capture/reports/database/principal.md): Reference for the Principal table in the ABBYY FlexiCapture reports database: columns holding users and user groups, their names, email, roles, and tenant.
- [PrincipalLink](https://docs.abbyy.com/flexi-capture/reports/database/principal-link.md): Reference for the PrincipalLink table in the ABBYY FlexiCapture reports database: columns mapping membership between users and parent groups.
- [PrincipalPermission](https://docs.abbyy.com/flexi-capture/reports/database/principal-permission.md): Reference for the PrincipalPermission table in the ABBYY FlexiCapture reports database: columns granting role-based access to projects and batch types.
- [Tenant](https://docs.abbyy.com/flexi-capture/reports/database/tenant.md): Reference for the Tenant table in the ABBYY FlexiCapture reports database: columns listing every tenant, its license number, description, and license sharing.
- [Statistics](https://docs.abbyy.com/flexi-capture/reports/database/statistics.md): Overview of the statistics tables in the ABBYY FlexiCapture reports database, which retain batch processing data for reports even after a batch is deleted.
- [StatisticBatchArchive](https://docs.abbyy.com/flexi-capture/reports/database/statistic-batch-archive.md): Reference for the StatisticBatchArchive table in the ABBYY FlexiCapture reports database: columns recording each batch for which statistics were gathered.
- [StatisticBatchDayActivity](https://docs.abbyy.com/flexi-capture/reports/database/statistic-batch-day-activity.md): Reference for the StatisticBatchDayActivity table in the ABBYY FlexiCapture reports database: columns holding hourly batch throughput per processing stage.
- [StatisticBatchDocumentTypeArchive](https://docs.abbyy.com/flexi-capture/reports/database/statistic-batch-document-type-archive.md): Reference for the StatisticBatchDocumentTypeArchive table in the ABBYY FlexiCapture reports database: per-batch counts of documents and pages by document type.
- [StatisticBatchParameterArchive](https://docs.abbyy.com/flexi-capture/reports/database/statistic-batch-parameter-archive.md): Reference for the StatisticBatchParameterArchive table in the ABBYY FlexiCapture reports database: name and value pairs of batch parameters kept for statistics.
- [StatisticConnections](https://docs.abbyy.com/flexi-capture/reports/database/statistic-connections.md): Reference for the StatisticConnections table in the ABBYY FlexiCapture reports database: user connection counts by role and tenant, sampled every 10 minutes.
- [StatisticDocuments](https://docs.abbyy.com/flexi-capture/reports/database/statistic-documents.md): Reference for the StatisticDocuments table in the ABBYY FlexiCapture reports database: per-document-type edit statistics, corrected errors, and verified fields.
- [StatisticExceptionTask](https://docs.abbyy.com/flexi-capture/reports/database/statistic-exception-task.md): Reference for the StatisticExceptionTask table in the ABBYY FlexiCapture reports database: detailed data on tasks handled in the Exceptions stage.
- [StatisticProductivity](https://docs.abbyy.com/flexi-capture/reports/database/statistic-productivity.md): StatisticProductivity table in the ABBYY FlexiCapture reporting database stores performance indicators recorded every 10 minutes for batches and queues.
- [StatisticTasks](https://docs.abbyy.com/flexi-capture/reports/database/statistic-tasks.md): StatisticTasks table in the ABBYY FlexiCapture reporting database holds daily per-batch task counts such as completed, canceled, and exception tasks.
- [Event log](https://docs.abbyy.com/flexi-capture/reports/database/events-reports-database.md): Overview of the Event Log tables in the ABBYY FlexiCapture reporting database, with a diagram linking the EventLog and DocumentEditingStatistic tables.
- [EventLog](https://docs.abbyy.com/flexi-capture/reports/database/event-log.md): EventLog table in the ABBYY FlexiCapture reporting database records system events with columns for event type, batch, document, stage routing, and timing.
- [DocumentEditingStatistic](https://docs.abbyy.com/flexi-capture/reports/database/document-editing-statistic.md): DocumentEditingStatistic table in the ABBYY FlexiCapture reporting database tracks user edits, including corrected symbols, verified fields, and rule errors.
- [Dictionaries](https://docs.abbyy.com/flexi-capture/reports/database/dictionaries.md): Index of the dictionary tables in the ABBYY FlexiCapture reporting database, linking the Role, RoleProcessingStage, RoleWorkstationType, and WorkstationType.
- [Role](https://docs.abbyy.com/flexi-capture/reports/database/role.md): Role table in the ABBYY FlexiCapture reporting database holds user role records with columns for the role name, project, and user role type.
- [RoleProcessingStage](https://docs.abbyy.com/flexi-capture/reports/database/role-processing-stage.md): RoleProcessingStage table in the ABBYY FlexiCapture reporting database maps the relationships between user roles and the processing stages they are assigned to.
- [RoleWorkstationType](https://docs.abbyy.com/flexi-capture/reports/database/role-workstation-type.md): RoleWorkstationType table in the ABBYY FlexiCapture reporting database links each user role to the station types permitted for that role.
- [WorkstationType](https://docs.abbyy.com/flexi-capture/reports/database/workstation-type.md): WorkstationType table in the ABBYY FlexiCapture reporting database lists station types with columns for the station name, project, and standard type value.
- [Enumerations](https://docs.abbyy.com/flexi-capture/reports/database/enumerators.md): Index of enumerations in the ABBYY FlexiCapture reporting database, covering predefined values for priority, task status, roles, stations, stages, and events.
- [Priority](https://docs.abbyy.com/flexi-capture/reports/database/priority-enum.md): Priority enumeration in the ABBYY FlexiCapture reporting database, listing the possible task priority values from Lowest (0) through Extra-High (5).
- [Task status](https://docs.abbyy.com/flexi-capture/reports/database/task-state-enum.md): Task status enumeration in the ABBYY FlexiCapture reporting database, listing processing task states such as being created, ready, and under processing.
- [Types of image sources](https://docs.abbyy.com/flexi-capture/reports/database/source-type-enum.md): Image source type enumeration in the ABBYY FlexiCapture reporting database, listing the possible sources of document images: file, scanner, custom, and unknown.
- [Object types](https://docs.abbyy.com/flexi-capture/reports/database/object-type-enum.md): Object type enumeration in the ABBYY FlexiCapture reporting database, listing the possible object types referenced in reports: batch, document, and project.
- [User role types](https://docs.abbyy.com/flexi-capture/reports/database/role-type-enum.md): User role type enumeration in the ABBYY FlexiCapture reporting database, listing roles such as Scanning Operator, Verification Operator, and Administrator.
- [Station types](https://docs.abbyy.com/flexi-capture/reports/database/station-type-enum.md): Station type enumeration in the ABBYY FlexiCapture reporting database, listing predefined stations such as Scanning, Verification, and Web Capture Station.
- [Processing stage types](https://docs.abbyy.com/flexi-capture/reports/database/stage-type-enum.md): Processing stage type enumeration in the ABBYY FlexiCapture reporting database, listing stages such as Recognition, Data Verification, Export, and Exceptions.
- [Event types](https://docs.abbyy.com/flexi-capture/reports/database/event-type.md): Event type enumeration in the ABBYY FlexiCapture reporting database, listing logged events such as session open, document saved, and batch created.
- [Examples of custom reports](https://docs.abbyy.com/flexi-capture/reports/examples/examples.md): Custom report examples installed with ABBYY FlexiCapture in the Administration and Monitoring Console, based on a stored procedure and on an SQL query DataSet.
- [Report based on a stored procedure](https://docs.abbyy.com/flexi-capture/reports/examples/stored-procedure.md): Example of an ABBYY FlexiCapture custom report built on a stored procedure, describing the XML definition and RPT files that return the first 100 records.
- [Report based on an SQL query](https://docs.abbyy.com/flexi-capture/reports/examples/sql.md): Example of an ABBYY FlexiCapture custom report built on an SQL query, describing the XML definition and RPT files that return the first 100 event log records.

## Appendix

- [Develop solutions](https://docs.abbyy.com/flexi-capture/appendix/develop-solutions.md): Build and protect ABBYY FlexiCapture solutions for resale, securing Document Definitions, FlexiLayouts, and rule modules with developer licenses.