Serviço de Extração de Conteúdo Textual de Arquivos de Imagem

Rota para extração do conteúdo textual de arquivos.

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 <base64>

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:

returnCrops

boolean

optional

Se verdadeiro, retorna os recortes dos binários das imagens contidas dentro de um documento tipificado com a perspectiva corrigida, como recortes de foto, assinatura, código de barras e impressão digital. Consulte a lista de documentos lidos para visualizar todos os crops disponíveis.

Default:

false

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

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.

tables

array [object {5}] | null

table

optional

Lista de tabelas encontradas no conteúdo.

crops

array [object {3}] | null

optional

stdType

string | null

optional

Atributo que retorna o tipo de conteúdo identificado padronizado. Ex: personal document, certificate, etc.

processType

string | null

optional

Indica de qual processo o retorno apresentado é originário. Ex: extraction para o processo de extração de dados do mostQI.

metadata

object

optional

barcodes

array [object {3}]

optional

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

code

string

required

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

message

string | null

required

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

errors

object | null

required

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

Examples

Sucesso Sync (com crops)Sucesso Sync (com tables)Sucesso Sync (com result e metadata.barcodes)Sucesso Sync (result vazio com metadata.barcodes)

{
    "result": [
        {
            "fields": [
                {
                    "name": "num_registro",
                    "stdName": null,
                    "value": "7636377",
                    "score": 1
                },
                {
                    "name": "numero_registro",
                    "stdName": null,
                    "value": "7636377",
                    "score": 1
                },
                {
                    "name": "data_emissao",
                    "stdName": null,
                    "value": "2017-09-20",
                    "score": 1
                },
                {
                    "name": "data_expedicao",
                    "stdName": null,
                    "value": "2017-09-20",
                    "score": 1
                },
                {
                    "name": "data_validade",
                    "stdName": null,
                    "value": "2024-06-11",
                    "score": 1
                },
                {
                    "name": "nome",
                    "stdName": null,
                    "value": "JUNIOR CARDOSO VILARINO",
                    "score": 0.75
                },
                {
                    "name": "filiacao_2",
                    "stdName": null,
                    "value": "JOÃO CARLOS VILARINO",
                    "score": 0.71
                },
                {
                    "name": "filiacao_1",
                    "stdName": null,
                    "value": "MARIA OLIVEIRA CARDOSO",
                    "score": 1
                },
                {
                    "name": "naturalidade_uf",
                    "stdName": null,
                    "value": "MA",
                    "score": 0.99
                },
                {
                    "name": "naturalidade",
                    "stdName": null,
                    "value": "MA",
                    "score": 0.99
                },
                {
                    "name": "nacionalidade",
                    "stdName": null,
                    "value": "BR",
                    "score": 0.99
                },
                {
                    "name": "data_nascimento",
                    "stdName": null,
                    "value": "1986-05-16",
                    "score": 1
                },
                {
                    "name": "pis_pasep",
                    "stdName": null,
                    "value": "",
                    "score": 0.99
                },
                {
                    "name": "cpf",
                    "stdName": null,
                    "value": "55972690624",
                    "score": 0.99
                },
                {
                    "name": "tipo_sanguineo",
                    "stdName": null,
                    "value": "O+",
                    "score": 0.99
                },
                {
                    "name": "data_validade_amh",
                    "stdName": null,
                    "value": "Indeterminada",
                    "score": 0.99
                },
                {
                    "name": "categoria",
                    "stdName": null,
                    "value": "TERCEIRO SARGENTO",
                    "score": 1
                },
                {
                    "name": "documento_origem",
                    "stdName": null,
                    "value": "Cert Nasc LV 237 - FL 128 - Termo 212456 SÃO LUIS - MA",
                    "score": 0.99
                },
                {
                    "name": "doc_origem",
                    "stdName": null,
                    "value": "Cert. Nasc.: LV 237 - FL 128 - Termo 212456\nSÃO LUIS - MA",
                    "score": 0.99
                }
            ],
            "crops": [],
            "image": null,
            "score": 0.98,
            "type": "documento-pessoal",
            "stdType": "personal-document",
            "pageNumber": 1,
            "tags": [
                "country=bra",
                "id=bra-rg-marinha-2",
                "language=pt-BR",
                "of=armed-forces",
                "of=military",
                "of=navy",
                "person=natural",
                "process-type=extraction",
                "region=back",
                "region=verso",
                "std-type=personal-document",
                "subtype=carteira-funcional",
                "subtype=functional-card",
                "subtype=identity",
                "subtype=rg",
                "type=documento-pessoal"
            ],
            "tables": [],
            "processType": "extraction"
        },
        {
            "fields": [
                {
                    "name": "assinado",
                    "stdName": null,
                    "value": "1",
                    "score": 0.94
                },
                {
                    "name": "assinatura",

🟠400R101 A specified parameter is wrong

🟠400R130 Unsupported file format

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Content Extraction [application/json]

Request

Request samples

Responses