Conheça a nossa nova rota Liveness Streaming!

Content Extraction Async [application/json]

POST

https://mostqiapi.com/process-image/content-extraction

iocrcontent extractiondoc extractionextração de dadosocr

Last modified:2025-03-13 17:45:11

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

INFO

O resultado enviado ao servidor de callback segue o mesmo padrão do resultado é o mesmo da rota Content Extraction [multipart/form-data], com a adição do processId.

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params application/json

webhook

object

optional

url

string | null

optional

É a URL em que será feita a chamada quando o processo assíncrono finalizar.

fallbackUrl

string | null

optional

Parâmetro que permite especificar outra URL caso haja falha de comunicação na chamada da URL especificada no parâmetro webhookUrl ou webhook.fallbackUrl.

authorization

object | null

optional

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.

Match pattern:

RFC3548

fileUrl

string

optional

🔸Requerido quando o parâmetro file 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 obrigatorio. 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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://mostqiapi.com/process-image/content-extraction' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhook": {
        "url": "",
        "fallbackUrl": "",
        "authorization": {
            "headers": [
                {
                    "name": "nomeCabecalho1",
                    "value": "valorCabecalho1"
                },
                {
                    "name": "nomeCabecalho2",
                    "value": "valorCabecalho2"
                }
            ],
            "queryStrings": [
                {
                    "name": "nomeQs1",
                    "value": "valorQs1"
                },
                {
                    "name": "nomeQs2",
                    "value": "valorQs2"
                }
            ],
            "mtls": false
        }
    },
    "fileBase64": "",
    "fileUrl": "",
    "filePassword": "",
    "returnImage": false,
    "returnedImageQuality": "",
    "returnCrops": false,
    "tags": [
        ""
    ]
}'

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 mostQI ao endpoint especificado no corpo da requisição através dos parâmetros webhookUrl ou webhookFallbackUrl.

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.

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

object | null

required

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

Example

{
  "result": {
    "processId": "67a7ae91-4d7f-48e2-ad03-94ff19e1b32d"
  },
  "requestId": "kyamMSMguEe19elsr6SFB",
  "elapsedMilliseconds": 17,
  "status": {
    "message": "Ok",
    "code": "201",
    "errors": null
  }
}

🟢200OK webhook

🟠401R117 Invalid authorization data

🟠400R101 A specified parameter is wrong

🟠400R130 Unsupported file format

🔴500E100 The request could not be processed

Modified at 2025-03-13 17:45:11

Content Extraction Async Status [multipart/form-data]

Content Extraction Async Status [application/json]