Requests

External Image URLs

Instead of transferring document images to the Web Service as the Base64-encoded data, you can provide external URLs to the images for processing.

Warning

Passing external URLs as a request parameter is not completely secure, so use this method with caution.

To enable the Web Service accepting the external image URLs (disabled by default), use:

config.yaml

service:
  processing:
    externalImageUrl: true

In request parameters, use:

{
    "processParam": {
        "scenario": "FullAuth"
    },
    "ImageUrls": [
        "https://example.com/image1.png",
        "https://example.com/image2.png"
    ]
}

Request Limits

A request limit helps protect the system from overload when it is exposed to the internet and accessed directly by users. It ensures stable performance for all users, reduces the risk of accidental traffic spikes, and makes resource usage more predictable.

The following configuration is used by default and works for most use cases:

config.yaml

sdk:
  requestLimits:
    bodySizeMax: 0
    imagesCountMax: 20
    imagesPerPageMax: 10
    imagesBytesTotalMax: 0

Parameter	Type	Default	Description
bodySizeMax	integer	0 (no limit)	Maximum size of the incoming request.json in bytes.
imagesCountMax	integer	20	Maximum number of images in a request.
imagesPerPageMax	integer	10	Maximum number of images per one document page.
imagesBytesTotalMax	integer	0 (no limit)	Maximum total raw images volume.