MOST Docs
mostQI APImostValid API
DEMO
  • Generative Content Extraction
  • Content Extraction
  • Multipage Content Extraction
  • Vio Extraction
  • Liveness
  • Facematch
  • Invoice Extraction
  • Address Parsing
  • License Plate
mostQI APImostValid API
DEMO
  • Generative Content Extraction
  • Content Extraction
  • Multipage Content Extraction
  • Vio Extraction
  • Liveness
  • Facematch
  • Invoice Extraction
  • Address Parsing
  • License Plate
Help Desk
MOST Linkedin
MOSTQI Instagram
MOST Youtube
pt-BR
en-US
pt-BR
en-US
  1. mostValid
  • Introdução
  • Consumindo a API
  • Características da API
  • Mensagens de erro
  • Material de Apoio
  • mostValid
    • Authenticate (Get JWT)
      POST
    • Content Extraction
      POST
    • Process Status
      POST
  • mostValid Generative
    • Generative Authenticate (Get JWT)
      POST
    • Generative Content Extraction
      POST
    • Generative Process Status
      POST
  1. mostValid

Content Extraction

POST
https://mostvalid.com.br/process-image/content-extraction
webhookregrastarefasextracaoocr
Last modified:2025-02-13 17:11:40

Valores aceitos para o parâmetro scoreFlag #

IGNORE_NULL: Somente será feita a avaliação de campos, tabelas ou documentos retornados pelo mostQI que possuírem scores menores do que o especificado na configuração, ou seja, o retorno com score nulo será ignorado no processamento da geração de tarefas.
CONSIDER_NULL: Será feita a avaliação de campos, tabelas ou documentos retornados pelo mostQI que possuírem scores menores do que o especificado na configuração ou possuírem seu valor igual a nulo, ou seja, o retorno com score nulo será considerado no processamento da geração de tarefas.
IGNORE_SCORE: Independente do score retornado pelo mostQI será aberto uma tarefa para avaliação do campo, tabela ou documento.

Validação das entradas#

Quando o parâmetro webhook é fornecido, uma chamada intermediária será disparada quando o processo inicial de extração for finalizado. Essa chamada adicional tem o propósito de transmitir a situação parcial do processo, indicando quais entidades (campos, tabelas, células e documentos) estão pendentes de avaliação humana, identificadas pelo status 'TO_ANALYSIS', e quais entidades não requerem avaliação humana, identificadas pelo status 'MOSTQIIOCR'.

Campos depreciados#

Campos depreciados são nomes de campos descontinuados no padrão de nomenclatura de campos do mostQI. Embora esses campos ainda possam estar presentes na versão atual do resultado da extração, não são mais recomendados para uso.
Os campos depreciados não são considerados pelo mostValid para geração de tarefas e não são exibidos nas tarefas de análise.
Para os clientes que ainda utilizam campos depreciados em suas operações, recomendamos a substituição pelo campo atualizado correspondente.
NOTE
Confira a listagem atualizada de documentos e respectivos campos aqui.

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 RFC3548, usando a codificação base64.
Match pattern:
RFC3548
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, pois PDFs permitem que as senhas sejam dados binários.
Match pattern:
RFC3548
returnImage
boolean 
optional
Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida.
Default:
false
returnedImageQuality
integer 
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<= 100
Default:
75
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
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.
webhook
object 
optional
url
string 
optional
Endpoint para o qual o mostValid fará uma requisição enviando os dados processados do documento durante o processo de extração. Insira no valor a URL que receberá a chamada do mostValid.
fallbackUrl
string 
optional
Parâmetro que permite especificar outra URL caso haja falha de comunicação na chamada da URL especificada no parâmetro “webhook.url“.
authorization
object 
optional
operation
object 
optional
id
string 
required
Identificador único da operação, a ser criado e fornecido pelo cliente, devendo ser um GUID (globally unique identifier).
maxRetries
integer 
required
Quantidade máxima de tentativas de captura que o cliente poderá enviar ao processo, podendo variar de 2 a 10 tentativas. Se o cliente não enviar um documento com uma captura satisfatória que resulte em uma extração desejável, indicada pelos scores desejados para sua aplicação, após N tentativas, o mostValid procederá com a abertura da tarefa para análise humana. Nesse caso, será selecionado o documento com o maior score dentre os enviados. Em caso de empate de score, será considerado o documento com maior score com a captura mais recente.
>= 2<= 10
timeoutSeconds
integer 
required
Tempo máximo, em segundos, durante o qual o sistema aguardará uma nova entrada no processo. Este período pode variar de 1 a 900 segundos. Se nenhuma nova tentativa de captura for enviada dentro do tempo especificado, uma tarefa será aberta para análise do(s) documento(s) com o maior score dentre os enviados. Em caso de empate de score, será considerado o documento com maior score com a captura mais recente.
>= 1<= 900
generationRules
array [object {10}] 
optional
Lista de regras para geração de tarefas a serem consideradas durante o processamento do documento. É permitido o envio de até 5 regras. Ao utilizar esse parâmetro, a lista de regras inserida irá sobrescrever as regras cadastradas, caso existam.
tags
string 
required
Regex que define quais tags serão verificadas nos filtros. É possível utilizar tags específicas para um determinado documento ou definir que todos os documentos enviados ao mostValid sejam revisados, neste segundo caso utilize ^(id=.+)$.
documentConfiguration
object 
required
generalFieldConfiguration
object 
required
generalTableConfiguration
object 
required
specificFieldConfiguration
array [object {3}] 
required
Lista de campos específicos, respectivos scores mínimos e scoreFlags para gerar tarefas.
specificTableConfiguration
array [object {3}] 
required
Lista de tabelas específicas, respectivos scores mínimos e scoreFlags para gerar tarefas.
fieldsNameWhitelist
array[string]
optional
Estabelece uma whitelist de campos cujas configurações das regras de score serão aplicadas exclusivamente aos campos nela especificados.
tablesNameWhitelist
array[string]
optional
Estabelece uma whitelist de tabelas cujas configurações das regras de score serão aplicadas exclusivamente aos campos nela especificados.
fieldsNameBlacklist
array[string]
optional
Campos que obrigatoriamente não serão revisados, independentemente do score (no caso de geração de tarefa).
tablesNameBlacklist
array[string]
optional
Tabelas que obrigatoriamente não serão revisadas, independentemente do score (no caso de geração de tarefa).
Example
{
  "fileBase64": "SGVsbG8gd29ybGQh...",
  "fileUrl": "https://example.com/file.pdf",
  "returnImage": true,
  "returnedImageQuality": 90,
  "webhook": {
    "url": "https://example.com/webhook",
    "fallbackUrl": "https://fallback.example.com/webhook",
    "authorization": {
      "headers": [
        {
          "name": "Authorization",
          "value": "Bearer token"
        }
      ],
      "queryStrings": [
        {
          "name": "apiKey",
          "value": "123456789"
        }
      ]
    }
  },
  "operation": {
    "id": "d2cbc642-9912-4a12-9931-653a17a6afef",
    "maxRetries": 3,
    "timeoutSeconds": 60
  },
  "generationRules": [
    {
      "documentConfiguration": {
        "score": 0.8,
        "scoreFlag": "IGNORE_NULL"
      },
      "generalFieldConfiguration": {
        "score": 0.7,
        "scoreFlag": "CONSIDER_NULL"
      },
      "generalTableConfiguration": {
        "score": 0.5,
        "scoreFlag": "IGNORE_SCORE"
      },
      "specificFieldConfiguration": [
        {
          "name": "cpf",
          "score": 0.9,
          "scoreFlag": "IGNORE_NULL"
        }
      ],
      "specificTableConfiguration": [
        {
          "name": "tabela_categorias",
          "score": 0.6,
          "scoreFlag": "IGNORE_NULL"
        }
      ],
      "fieldsNameWhitelist": [
        "cpf",
        "data_emissao"
      ],
      "tablesNameWhitelist": [
        "tabela_categorias"
      ]
    }
  ]
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mostvalid.com.br/process-image/content-extraction' \
--header 'Authorization: Bearer {{bearer_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileBase64": "SGVsbG8gd29ybGQh...",
    "fileUrl": "https://example.com/file.pdf",
    "returnImage": true,
    "returnedImageQuality": 90,
    "webhook": {
        "url": "https://example.com/webhook",
        "fallbackUrl": "https://fallback.example.com/webhook",
        "authorization": {
            "headers": [
                {
                    "name": "Authorization",
                    "value": "Bearer token"
                }
            ],
            "queryStrings": [
                {
                    "name": "apiKey",
                    "value": "123456789"
                }
            ]
        }
    },
    "operation": {
        "id": "d2cbc642-9912-4a12-9931-653a17a6afef",
        "maxRetries": 3,
        "timeoutSeconds": 60
    },
    "generationRules": [
        {
            "documentConfiguration": {
                "score": 0.8,
                "scoreFlag": "IGNORE_NULL"
            },
            "generalFieldConfiguration": {
                "score": 0.7,
                "scoreFlag": "CONSIDER_NULL"
            },
            "generalTableConfiguration": {
                "score": 0.5,
                "scoreFlag": "IGNORE_SCORE"
            },
            "specificFieldConfiguration": [
                {
                    "name": "cpf",
                    "score": 0.9,
                    "scoreFlag": "IGNORE_NULL"
                }
            ],
            "specificTableConfiguration": [
                {
                    "name": "tabela_categorias",
                    "score": 0.6,
                    "scoreFlag": "IGNORE_NULL"
                }
            ],
            "fieldsNameWhitelist": [
                "cpf",
                "data_emissao"
            ],
            "tablesNameWhitelist": [
                "tabela_categorias"
            ]
        }
    ]
}'

Responses

🟢200OK
application/json
Body
result
object 
required
Lista contendo o resultado do método (consulte na documentação específica de cada um).
processId
string 
required
ID referente ao processo assíncrono de extração iniciado a partir desta requisição. Este ID é uma referência, e será enviado nas requisições assíncronas que serão feitas pelo servidor do mostValid ao endpoint especificado no cabeçalho webhook.
operationId
string 
optional
Identificador único da operação, a ser criado e fornecido pelo cliente, devendo ser um GUID - Globally Unique Identifier.
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 
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": {
    "processId": "1ccbdf64-f13b-4bf2-0d33-eade1e85c598",
    "operationId": "8b024a8c-c7e8-4bb4-9fb6-08304d278388"
  },
  "requestId": "VOUj0Ay9DESqp2RowoaItt",
  "elapsedMilliseconds": 100,
  "status": {
    "message": "Ok",
    "code": "201",
    "errors": null
  }
}
🟠400R101 A specified parameter is wrong
🟠400R300 Client isn't registered yet or has a invalid token
🔴500E100 The request could not be processed
Modified at 2025-02-13 17:11:40
Previous
Authenticate (Get JWT)
Next
Process Status
Built with