Verification

Any characters recognized with an insufficient degree of confidence are submitted for verification by human operators. Verification operators either confirm or correct low-confidence characters.

Verification URLs

For tasks created in the REST API, verification is configured in projects. Please refer to the ABBYY FlexiCapture Cloud REST API sample project section for detailed instructions.

You can integrate the verification UI into third-party systems via an <iframe> element, eliminating the need for additional tenant authentication. To direct verification operators to the data to be verified, unique URLs are used.

Note: A verification URL can only be opened once in one browser window, i.e. documents from one task can only be verified by one user at a time. The total number of tasks that users can open in the verification UI is determined by the licensing restrictions of a tenant (see the License parameters section for details).

The verification UI offers the same functionality as the Web Verification Station (see the About the Web Verification Station section for details).

Opening the verification UI

To open the verification UI for a REST API task, follow these steps:

  1. Using the REST API, create a document processing task.
  2. Track the task status. Note that the verification UI can only be opened for tasks with the WaitForAction status. Please refer to the ABBYY FlexiCapture Cloud REST API task status section for more information about task statuses.
  3. Create a verification URL:
    1. Get verification_id in the task object.
    2. Use verification_id to create a URL in the following format:

https://{api-portal-host}/verification/{verification_id},

where {api-portal-host} is your region host and {verification_id} is the verification identifier.

For example, https://cloud-us.flexicapture.com/verification/7bfb534eb05217799deb93d524cd8257

  1. Open the verification URL in a browser or via an <iframe> element.

Note: No additional authentication is required to open verification URLs.

  1. Wait for the “FC_Verification_TaskClosed” message from the <iframe> element. This message signals that the verification has been completed (see <iframe> element events below for details).
  2. Track the task status. You will be able to download the files after the processing is completed.

Please refer to the Processing error diagnostics section for instructions on viewing the event log and identifying tasks that have been processed with errors.

Sample code illustrating how to open the verification UI using verification id

<iframe> element events

The table below lists the possible <iframe> events:

FC_Verification_TaskClosed

Verification completed.

REST API task status changed to “InProgress” for exporting data; REST API task status changed to “Done” for downloading files.

FC_Verification_TaskRejected Task rejected and returned to the queue.
FC_Verification_TaskPostponed Task postponed and returned to the queue.
FC_Verification_TaskSentToException Task sent to the Exceptions folder due to an error.
FC_Verification_TaskSentToRecognition Task sent to the re-recognition stage.
FC_Verification_TaskSentToStage Task sent to another stage.
FC_Verification_TaskSentToRescan Task sent to the re-scanning stage.

Once a message has been received from the <iframe> element, the verification UI can be closed and the user can be returned to the third-party system.

15.09.2020 9:42:43


Please leave your feedback about this article