License Plate Recognition [application/json]

Request body description

Name	Type	Mandatory	Description
fileBase64	String	Yes, if the fileUrl parameter is not provided	Binary content of the file to be processed, encoded as a text string according to the RFC3548 standard using base64 encoding.
fileUrl	String	Yes, if the fileBase64 parameter is not provided	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	It's not mandatory. Allows you to set the quality of the returned deskew image in the extraction path. The attribute is optional, and its default value (when not reporting) is 75.

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

required

fileUrl

string

required

returnImage

boolean

required

returnedImageQuality

string

required

filePassword

string

required

Example

{
  "fileBase64": "",
  "fileUrl": "",
  "returnImage": true,
  "returnedImageQuality": "",
  "filePassword": ""
}

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

License Plate Recognition [application/json]

Request body description#

Request

Request samples

Responses

Request body description