TransportAPIOptions

Interface

Properties

Name	Type	Description
apiKey	string	The API key to be used for authentication.
cloudServiceRegion?	"AUTO" | "EU" | "US"	The cloud service region to use - "AUTO" for latency-based automatic routing (default), "EU" for Europe and "US" for the United States. Has no effect if endpoint is also set.
disableAdditionalCode?	boolean	Disables additional code reading for iso and eu-rail. Sends X-Disable-Additional-Code. Supported by OCR engines from 7.3.20.46. When explicitly set, this option takes precedence over disableISOCode, including when its value is false.
disableChecksumCheck?	boolean	Deprecated. Checksum checks are internal and not configurable from 7.3.20.46 onward. Sends the legacy X-Disable-Checksum-Check header, retained for compatibility with older OCR engines. From 7.3.20.46, checksum checks are handled internally by the engine and cannot be configured. This option has no effect on the returned result.
disableISOCode?	boolean	Deprecated. Use disableAdditionalCode instead. Legacy additional-code switch for iso and eu-rail. Sends X-Disable-Iso-Code. On OCR engines from 7.3.20.46, it is a fallback only when disableAdditionalCode is not set.
disableImageResizing?	boolean	The service resizes large images to Full HD resolution by bicubic interpolation. Resizing can make reading many times faster, but it can reduce the recognition efficiency. If you don't want the service to resize your images, turn this feature on by setting the property value to true. By disabling image resizing, you may also need to enable wide range analysis.
enableFullUsAccrCode?	boolean	Enables full US ACCR code recognition. Sends X-Enable-Full-Us-Accr-Code. Applies only to the TRUCK engine (truck code type, or legacy accr_usa); other engines ignore it.
enableWideRangeAnalysis?	boolean	If you cannot guarantee that the uploaded image meets all the required parameters (see the Input Images tab on the How To Use page), you can turn on the wide-range analysis by setting this property's value to true. Attention! The duration of the analysis may increase several times.
endpoint?	string	The URL of the API endpoint to call. Optional if cloudServiceRegion is also set. Overrides cloudServiceRegion if both properties are set.
maxReads?	number	An optional parameter, it specifies the maximum number of vehicle/license plate searches per image. Use this parameter carefully, because every search increases the processing time. The system will stop searching when there is no more vehicle/license plate in the image, or the number of searches reaches the value of maxreads. Its value is 1 by default, the maximum is 5.
retryCount?	number	How many times the request should be retried in case of a 5XX response status code. Default: 3.
type	CodeType	The type of code to read.

---

Source: transport/options.ts:54