Content Classification [application/json]

Synchronous route for document classification.

Request

Header Params

Authorization

string

required

Authorization token obtained from the user/authenticate method.

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

optional

🔸Required when the fileUrl parameter is not provided. Binary of the file to be processed, encoded in text string according to RFC3548 standard using base64 encoding.

fileUrl

string

optional

🔸Required when the fileBase64 parameter is not provided. Public Url of the file to be processed.

filePassword

string

optional

🔸Required if the submitted file is a password-encrypted PDF. The password must be encoded in a base64 string, since PDF files allow passwords to be binary data.

returnImage

boolean

optional

If true, returns the binary clipping of the typified images with the corrected perspective.

Default:

false

returnedImageQuality

string

optional

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.

>= 0 characters<= 100 characters

Default:

returnMetadata

boolean

optional

If true, it returns an object called metadata, which includes the reading of the QRCodes present in the document, organized within the barcodes object.
The QRCode extraction will be performed for:

Well-known and categorized documents by mostQI, which support Smart Docs;

Unknown or uncategorized documents, ensuring broad and flexible coverage.

To ensure accurate extraction of the QRCode content, it is essential that they are complete and legible in the processed document.

Default:

false

tags

array[string]

optional

Optional parameter that aids in document identification, reducing processing time and enhancing detection accuracy, acting as a filter. Values entered in the tag array must be strings following the Regex pattern. Refer to the list of read documents to view all available tags.

Example

{
    "fileBase64": "",
    "fileUrl": "",
    "filePassword":"",
    "returnImage": false,
    "returnedImageQuality" :"",
    "tags": [
        ""
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

result

array [object {3}]

required

List containing the result of the method (refer to the specific documentation for each one).

type

string | null

optional

Attribute that returns the identified content type. E.g., personal document, certificate, etc.

stdType

string | null

optional

Attribute that returns the standardized identified content type. E.g., personal document, certificate, etc.

classifications

array [object {5}]

required

List containing attributes related to the classification of the document in the uploaded file.

requestId

string

required

Unique identification code of the request to the server, which will be recorded in the service consumption history.

elapsedMilliseconds

integer

required

Processing duration time in milliseconds.

status

object

required

Object containing the status code and message of the response.

message

string | null

required

Internal status code. See the possible values in the mostQI error messages.

code

string

required

Status return message. See the possible values in the mostQI error messages.

errors

array [object {2}] | null

required

List of Error objects, the format is variable.

Example

{
    "result": [
        {
            "type": "extrato",
            "stdType": "extract",
            "classifications": [
                {
                    "source": "iocr",
                    "score": 1,
                    "tags": [
                        "country=bra",
                        "id=bra-fgts-2",
                        "language=pt-BR",
                        "of=fund",
                        "process-type=classification",
                        "std-type=extract",
                        "subtype=fgts",
                        "type=extrato"
                    ],
                    "pages": [
                        {
                            "number": 1
                        }
                    ],
                    "image": null
                }
            ]
        },
        {
            "type": "documento-pessoal",
            "stdType": "personal-document",
            "classifications": [
                {
                    "source": "iocr",
                    "score": 0.93,
                    "tags": [
                        "country=bra",
                        "id=bra-rg-marinha-2",
                        "language=pt-BR",
                        "of=armed-forces",
                        "of=military",
                        "of=navy",
                        "person=natural",
                        "process-type=classification",
                        "region=back",
                        "region=verso",
                        "std-type=personal-document",
                        "subtype=carteira-funcional",
                        "subtype=functional-card",
                        "subtype=identity",
                        "subtype=rg",
                        "type=documento-pessoal"
                    ],
                    "pages": [
                        {
                            "number": 2
                        }
                    ],
                    "image": null
                }
            ]
        },
        {
            "type": "documento-pessoal",
            "stdType": "personal-document",
            "classifications": [
                {
                    "source": "iocr",
                    "score": 1,
                    "tags": [
                        "country=bra",
                        "has=fingerprint",
                        "has=photo",
                        "has=signature",
                        "id=bra-rg-marinha-2",
                        "language=pt-BR",
                        "of=armed-forces",
                        "of=military",
                        "of=navy",
                        "person=natural",
                        "process-type=classification",
                        "region=frente",
                        "region=front",
                        "std-type=personal-document",
                        "subtype=carteira-funcional",
                        "subtype=functional-card",
                        "subtype=identity",
                        "subtype=rg",
                        "type=documento-pessoal"
                    ],
                    "pages": [
                        {
                            "number": 2
                        }
                    ],
                    "image": null
                }
            ]
        }
    ],
    "requestId": "lXP7v8LZL925kRIA3WYOw",
    "elapsedMilliseconds": 3186,
    "status": {
        "message": "Ok",
        "code": "200",
        "errors": null
    }
}

🟠400R101 A specified parameter is wrong

🟠400R130 Unsupported file format

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed