API OCR FullReader: Processamento de Imagens e PDFs com Alta Precisão

Rota OCR FullReader para processamento avançado de imagens e documentos PDF, utilizando múltiplos motores de OCR para obter texto reconhecido com máxima precisão. Cada página analisada é avaliada com um score de qualidade

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

optional

🔸Requerido quando o parâmetro fileUrl não é informado.
Binário do arquivo a ser processado

fileUrl

string

optional

🔸Requerido quando o parâmetro file não é informado.
Senha codificada em uma string base64, pois PDFs permitem que as senhas sejam dados binários.

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).

pageNumber

integer

optional

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

score

number <float>

optional

Score que indica a qualidade da extração de OCR na rota de FullText (ContentFullreader). *O padrão de qualidade de imagem é definido com base em um score de referência de 0,5 ou superior.

Imagens de baixa qualidade (pixeladas) podem impactar negativamente no cálculo do score.

>= 0<= 1

fulltext

string

optional

Texto extraído do conteúdo do arquivo.

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.

elapsedMiliseconds

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.

code

string

required

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

message

string | null

required

Mensagem de retorno de status. 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": [
    {
      "pageNumber": 1,
      "score": 1,
      "fulltext": "FGTS EVALDO SANTOS DE JESUS CAIXA\nEMPREGADOR DATA DE ADMISSÃO PIS / PASEP\nPHOENIX PLANTAS LTDA 05 / 05 / 2009 324 . 55512 . 37 - 8\nCARTEIRA DE TRABALHO INSCRIÇÃO DO EMPREGADOR NÚMERO DA CONTA\n38916 / 391 9502669000156 9970523806238 / 120 - SP\nDATA DE OPÇÃO DATA E CÓDIGO DE AFASTAMENTO CATEGORIA\n05 / 05 / 2009 02 / 08 / 2009 - 13 1\nTIPO DE CONTA TAXA DE JUROS VALOR PARA FINS RESCISÓRIOS\nOPTANTE 3 % A . A . R $ 0 , 00\nHistórico de Movimentações Junho 2009 - Abril 2010\nDATA LANÇAMENTO VALOR ( R $ ) TOTAL ( R $ )\nSALDO ANTERIOR 0 , 00\n05 / 06 / 2009 115 - DEPOSITO MAIO / 2009 55 , 36\n10 / 07 / 2009 CREDITO DE JAM 0 , 003123 0 , 17 55 , 53\n07 / 07 / 2009 115 - DEPOSITO JUNHO / 2009 63 , 88 119 . 41\n03 / 08 / 2009 DEP RESCISORIO 08 / 2009 SBPC10 / 08 / 2009 20 , 23 139 , 64\n05 / 08 / 2009 SAQUE DEP - COD 04 - 119 , 24 20 , 40\n05 / 08 / 2009 SAQUE JAM COD 04 - 0 , 17 20 , 23\n03 / 08 / 2009 115 - DEPOSITO JULHO / 2009 63 , 88 84 , 11\n10 / 08 / 2009 SAQUE DEP - COD 04 - 20 , 23 63 , 88\n10 / 09 / 2009 CREDITO DE JAM 0 , 002663 0 , 17 64 , 05\n10 / 10 / 2009 CREDITO DE JAM 0 , 002466 0 , 15 64 , 20\n10 / 11 / 2009 CREDITO DE JAM 0 , 002466 0 , 15 64 , 35\n10 / 12 / 2009 CREDITO DE JAM 0 , 002466 0 , 15 64 , 50\n21 / 12 / 2009 AC REPOSICAO DEP EM 05 / 08 / 2009 119 , 24 183 , 74\n21 / 12 / 2009 AC REPOSICAO JAM EM 05 / 08 / 2009 0 , 17 183 , 91\n21 / 12 / 2009 AC AUT JAM CANCELAMENTO SAQUE 1 , 60 185 , 51\n21 / 12 / 2009 AC REPOSICAO DEP EM 10 / 08 / 2009 20 , 23 205 , 74\n21 / 12 / 2009 AC AUT JAM CANCELAMENTO SAQUE 0 , 20 205 , 94\n10 / 01 / 2010 CREDITO DE JAM 0 , 003000 0 , 61 206 , 55\n10 / 02 / 2010 CREDITO DE JAM 0 , 002466 0 , 50 207 , 05\n10 / 03 / 2010 CREDITO DE JAM 0 , 002466 0 , 51 207 , 56\n01 / 04 / 2010 SAQUE DEP - COD 04 - 203 , 35 4 , 21\n01 / 04 / 2010 SAQUE JAM - COD 04 - 4 , 21 0 , 00\nHistórico emitido em : 01 / 10 / 2018 - 15 : 03 Para uso da CAIXA : 013498\n\nSIME\n"
    }
  ],
  "requestId": "wRNAwWocsEOrGthzzfUCA",
  "elapsedMilliseconds": 2315,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Content Fullreader [multipart/form-data]

Request

Request samples

Responses