License Plate Recognition [application/json]

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

optional

🔸Requerido quando o parâmetro fileUrl não é informado. Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648, usando a codificação base64.

fileUrl

string

optional

🔸Requerido quando o parâmetro fileBase64 não é informado. Url pública do arquivo a ser processado.

filePassword

string <base64>

optional

🔸Requerido caso o arquivo enviado seja um PDF criptografado por senha.
A senha deve ser codificada em uma string base64 (RFC 4648), pois PDFs permitem que as senhas sejam dados binários.

returnImage

boolean

optional

Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida.

Default:

false

returnedImageQuality

string

optional

Não obrigatório. Permite definir a qualidade da imagem de deskew retornada na rota de extração. O atributo é opcional, e seu valor padrão (quando não informando) é 75.

>= 0 characters<= 100 characters

Default:

75

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mostqiapi.com/process-image/lpr' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileBase64": "",
    "fileUrl": "",
    "filePassword": "",
    "returnImage": true,
    "returnedImageQuality": ""
}'

Responses

🟢200OK

application/json

Body

result

array [object {7}]

required

Lista contendo o resultado do método (consulte na documentação específica de cada um).

fields

array [object {4}] | null

optional

Lista contendo as placas encontradas na imagem.

crops

array [object {3}] | null

optional

Lista com 'recortes' das respectivas áreas de imagem dos campos. Este campo só é retornado quando o parâmetro returnImage é utilizado.

score

number <float> | null

optional

type

string | null

optional

Tipo de conteúdo identificado

stdType

string | null

optional

Tipo de conteúdo identificado padronizado

pageNumber

integer | null

optional

Número da página na qual o conteúdo foi encontrado.

tags

array[string] | null

optional

Lista de tags relacionadas a imagem. As tags são um conjunto de identificadores que caracterizam a imagem e seus elementos.

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | 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": [
        {
          "name": "plate",
          "stdName": "plate",
          "value": "/9j/4AA...=="
        },
        {
          "name": "vehicle",
          "stdName": "vehicle",
          "value": "/9j/4AA...k="
        }
      ],
      "score": 0.85,
      "type": "plate",
      "stdType": "plate",
      "pageNumber": 1,
      "tags": [
        "plate"
      ]
    }
  ],
  "requestId": "XXXXXXXXXXXXXXXXXXXX",
  "elapsedMilliseconds": 860,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed