Generative Content Extraction [multipart/form-data]

CAUTION

O parâmetro tags é opcional e serve para indicar o modelo a ser utilizado no processamento do arquivo. Seu uso é recomendado para os documentos "Contrato Social" ou "Registro de Imóveis". Para os demais documentos, o envio de tags não é necessário.

Valores aceitos:

tag	modelo
id=bra-nlp-registro-imovel-1	Registro de Imóveis
id=bra-nlp-contrato-social-1	Contrato Social

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.

tags

string

optional

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.

returnMetadata

boolean

optional

Se verdadeiro, retorna um objeto chamado metadata, que inclui a leitura dos QRCodes presentes no documento, organizados dentro do objeto barcodes.
A extração de QRCodes será realizada para:

Documentos conhecidos e tipificados pelo mostQI, que possuem suporte a Smart Docs;

Documentos não conhecidos ou não tipificados, garantindo uma cobertura ampla e flexível.

Para garantir a extração precisa do conteúdo dos QRCodes, é fundamental que eles estejam completos e legíveis no documento processado.

Default:

false

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

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

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

Example

{
    "result": [
        {
            "type": "certificado",
            "stdType": "certificate",
            "extractions": [
                {
                    "source": "iocr",
                    "score": 0.9,
                    "tags": [
                        "id=bra-nlp-registro-imovel-1",
                        "language=pt-BR",
                        "of=property",
                        "std-type=certificate",
                        "type=certificado"
                    ],
                    "sections": [
                        {
                            "name": "cabecalho",
                            "stdName": "header",
                            "score": 0.9,
                            "fields": [
                                {
                                    "name": "matricula",
                                    "stdName": "registration",
                                    "value": "77777",
                                    "score": 0.85
                                },
                                {
                                    "name": "data_expedicao",
                                    "stdName": "issue_date",
                                    "value": "2013-08-26",
                                    "score": 0.79
                                },
                                {
                                    "name": "livro",
                                    "stdName": "book",
                                    "value": "2",
                                    "score": 0.99
                                },
                                {
                                    "name": "cartorio",
                                    "stdName": "registry",
                                    "value": "1º OFÍCIO DE REGISTRO DE IMÓVEIS",
                                    "score": 0.91
                                },
                                {
                                    "name": "endereco_cartorio",
                                    "stdName": "registry_address",
                                    "value": "Belo Horizonte/MG",
                                    "score": 0.99
                                },
                                {
                                    "name": "registro_anterior",
                                    "stdName": "previous_registry",
                                    "value": "Protocolo nº 109.187, em 01/08/2013 - CONVENÇÃO DE CONDOMÍNIO - Foi registrada sob o nº 875 no Livro 3 - Registro Auxiliar desta Serventia a convenção de condomínio do \" Edificio Vilas \".",
                                    "score": 0.95
                                },
                                {
                                    "name": "descricao_imovel",
                                    "stdName": "property_description",
                                    "value": "Apartamento nº 222, da Torre 2 - Sky, do empreendimento denominado \" Edifício Vilas \", situado na Rua Brilhante nº 222 com área privativa total real de 86,51m2, área de uso comum real de 75,50m2, área real total de 162,01m2, com direito ao uso da (s) vaga (s) de garagem nº 120D, e ao box nº 117, e fração ideal de 0,005647 do terreno constituído pelos lotes ns. 01 - A e 02 - A, da quadra \" P \", do loteamento denominado \" Vila da Vilaa \", em Belo Horizonte - MG, com área total de 6.847,00m2.",
                                    "score": 0.98
                                }
                            ],
                            "tables": [
                                {
                                    "name": "proprietarios_originais",
                                    "stdName": "original_owners",
                                    "score": 0.74,
                                    "headers": [
                                        {
                                            "name": "indice",
                                            "stdName": "index",
                                            "score": 1
                                        },
                                        {
                                            "name": "nome",
                                            "stdName": "name",
                                            "score": 0.98
                                        },
                                        {
                                            "name": "tipo_documento",
                                            "stdName": "document_type",
                                            "score": 0.99
                                        },
                                        {
                                            "name": "numero_documento",
                                            "stdName": "document_number",
                                            "score": 0.27
                                        },

🟠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