Skip to content

Getting Started

There are two types of endpoints right now. The old-async one, based on /webapi/Transaction2/SubmitTransaction and /webapi/Transaction2/GetTransactionResult, and the new-sync one, based on the /api/process method, which returns results in the same HTTP call. They are not connected, so you cannot use the transaction id from the process to get results in GetTransactionResult.

Basically, the old one is deprecated, and we recommend that all our new customers use the new type.


The new version of the Document Reader Web Service supports requests from the old Transaction API. If you run a new web service and send a Transaction request following the old logic, you will get the result processed using the new logic but in the format of the old web service interface.

To switch to the new API, see the migration guide below.

Migration from Old Transactional API

To migrate to the new API, take the following steps:

  1. Uninstall the old Document Reader Web Service.
  2. Install the new Document Reader Web Service.
  3. Rename the SLXXXXX license file to regula.license. Place it according to the setup license sections of your platform installation guide.
  4. Optionally, if you plan to migrate from Windows, ask your sales manager for a new license.
  5. Run the new Document Reader Web Service.

Supported Image File Formats

Document Reader SDK Web Service supports the following image file formats:

  • BMP
  • PNG
  • JPG / JPEG / JP2
  • TIF / TIFF
  • WebP
  • DAT
  • PDF

Next Steps