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.
disableChecksumCheck?	boolean	The codes the engine can recognize contain a checksum digit which can be used to check the validity of the digits read. A matching checksum indicates a high probability of the recognition result being correct. The Transportation & Cargo API verifies the checksum by default and discards any results where the check fails. By sending true as the value of this header, you can disable this check and receive all codes the engine recognized - even those known to be incorrect.
disableISOCode?	boolean	Disables searching for and reading the last 4 digits of the ISO container code. NOTE: This parameter is only used when using the iso code type, when searching for other code types, it has no effect.
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. NOTE: This parameter is only used when using the accr_usa code type, when searching for other code types, it has no effect.
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