License Plate Recognition [multipart/form-data]

Request Body Description

Name	Type	Required	Description
file	String	Yes	Binary content of the file to be processed.
fileUrl	String	Yes, if the file parameter is not sent	Public URL for accessing the file.
filePassword	String	Yes, if the sent file is an encrypted PDF	The password must be encoded in a base64 string, since PDF files allow passwords as binary data.
returnImage	Boolean	No	Returns image crops related to the extracted fields.
returnedImageQuality	Integer	No	Defines, on a scale from 0 to 100, the quality of the cropped image returned when the `returnImage` parameter is used.

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

file

required

Binary content of the file to be processed

fileUrl

string

required

Public Url of the file to be processed

filePassword

string

required

The password must be encoded in a base64 string, since PDFs allows passwords as binary data

returnImage

string

required

If true, returns image cuts related to the extracted fields

Example:

false

returnedImageQuality

string

required

Not mandatory. Defines, on a scale from 0 to 100, the quality of the cropped image returned when the returnImage parameter is true.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 OK Response

application/json

Body

result

array [object {7}]

required

fields

array [object {4}]

optional

crops

array

optional

score

number

optional

type

string

optional

stdType

string

optional

pageNumber

integer

optional

tags

array[string]

optional

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

message

string

required

code

string

required

errors

null

required

Example

{
    "result": [
        {
            "fields": [
                {
                    "name": "plate",
                    "stdName": "plate",
                    "value": "XXXXXXX",
                    "score": 0.9
                },
                {
                    "name": "vehicle_type",
                    "stdName": "vehicle_type",
                    "value": "XXXXXXX",
                    "score": 0.68
                }
            ],
            "crops": [],
            "score": 0.85,
            "type": "plate",
            "stdType": "plate",
            "pageNumber": 1,
            "tags": [
                "plate"
            ]
        }
    ],
    "requestId": "XXXXXXXXXXXXXXXXXXXX",
    "elapsedMilliseconds": 860,
    "status": {
        "message": "Ok",
        "code": "200",
        "errors": null
    }
}

🔴500500 Error Response