Generative Content Extraction [multipart/form-data]

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

file

required

Binário 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, pois PDFs permitem que as senhas sejam dados binários.

tags

string

optional

Parâmetro opcional que auxilia na identificação do documento, reduzindo o tempo de processamento e aprimorando a precisão da detecção, funcionando como um filtro. Os valores inseridos no vetor de tags devem ser strings que seguem o padrão Regex. Consulte a lista de documentos lidos para visualizar todas as tags disponíveis.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

result

array [object {3}]

required

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

type

string

required

Tipo do documento identificado (certificado, etc.).

stdType

string

required

Tipo padronizado do documento identificado (certificate, etc.).

extractions

array [object {4}]

required

Lista que contém objeto com informações detalhadas extraídas do documento.

requestId

string

required

Identificador único da solicitação.

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

optional

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}]

required

Lista de objetos do tipo Error, o formato é variável.

Example

{
    "result": [
        {
            "type": "certificate",
            "stdType": "certificate",
            "extractions": [
                {
                    "source": "iocr",
                    "score": 0.92,
                    "tags": [
                        "id=bra-nlp-property-registration-1",
                        "language=en-US",
                        "of=property",
                        "std-type=certificate",
                        "type=certificate"
                    ],
                    "sections": [
                        {
                            "name": "header",
                            "stdName": "header",
                            "score": 0.91,
                            "fields": [
                                {
                                    "name": "registration",
                                    "stdName": "registration",
                                    "value": "77777",
                                    "score": 0.9
                                },
                                {
                                    "name": "issue_date",
                                    "stdName": "issue_date",
                                    "value": "2013-08-26",
                                    "score": 0.79
                                },
                                {
                                    "name": "book",
                                    "stdName": "book",
                                    "value": "2",
                                    "score": 0.99
                                },
                                {
                                    "name": "registry",
                                    "stdName": "registry",
                                    "value": "PROPERTY REGISTRATION SERVICE DISTRICT OF NOVA LIMA MINAS GERAIS",
                                    "score": 0.99
                                },
                                {
                                    "name": "registry_address",
                                    "stdName": "registry_address",
                                    "value": "Bonita Avenue, 150, Central, Belo Horizonte/MG, 30180 - 000",
                                    "score": 0.99
                                },
                                {
                                    "name": "previous_registry",
                                    "stdName": "previous_registry",
                                    "value": "Previous Registry: 444444",
                                    "score": 0.91
                                },
                                {
                                    "name": "property_description",
                                    "stdName": "property_description",
                                    "value": "Apartment no. 222, Tower 2 - Sky, of the development named \"Edifício Vilas\", located at Rua Brilhante no. 222 with a total real private area of 86.51m2, total real common area of 75.50m2, total real area of 162.01m2, with the right to use parking space(s) no(s). 120D, and box no. 117, and ideal fraction of 0.005647 of the land constituted by lots no. 01 - A and 02 - A, of block \"P\", of the subdivision named \"Vila da Vilaa\", in Belo Horizonte - MG, with a total area of 6,847.00m2.",
                                    "score": 0.98
                                }
                            ],
                            "tables": [
                                {
                                    "name": "original_owners",
                                    "stdName": "original_owners",
                                    "score": 0.74,
                                    "headers": [
                                        {
                                            "name": "index",
                                            "stdName": "index",
                                            "score": 1
                                        },
                                        {
                                            "name": "name",
                                            "stdName": "name",
                                            "score": 0.98
                                        },
                                        {
                                            "name": "document_type",
                                            "stdName": "document_type",
                                            "score": 0.99
                                        },
                                        {
                                            "name": "document_number",
                                            "stdName": "document_number",
                                            "score": 0.99
                                        },
                                        {
                                            "name": "document_issuer",

🟠400R101 A specified parameter is wrong

🟠400R127 The uploaded file is encrypted by a password

🟠400R130 Unsupported file format

🔴500E100 The request could not be processed