Content Extraction Async [multipart/form-data]

Request

Header Params

Authorization

string

required

Token de autorização obtido no método Authentication/Authenticate

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

file

required

Binário do arquivo a ser processado

fileUrl

string

required

Url pública do arquivo a ser processado

filePassword

string

required

Obrigatório 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.

returnImage

string

required

Se verdadeiro, retorna o recorte dos binários das imagens tipificadas com a perspectiva corrigida

Example:

false

returnedImageQuality

string

required

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.

returnCrops

string

required

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.

Example:

false

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mostqiapi.com/process-image/content-extraction' \
--header 'Authorization: Bearer ' \
--form 'file=@""' \
--form 'fileUrl=""' \
--form 'filePassword=""' \
--form 'returnImage="false"' \
--form 'returnedImageQuality=""' \
--form 'returnCrops="false"' \
--form 'tags=""' \
--form 'webhookUrl=""' \
--form 'webhookFallbackUrl=""' \
--form 'webhookAuthorizationHeaders[0].name=""' \
--form 'webhookAuthorizationHeaders[0].value=""' \
--form 'webhookAuthorizationQueryStrings[0].name=""' \
--form 'webhookAuthorizationQueryStrings[0].value=""' \
--form 'webhookAuthorizationMtls="false"'

Responses

🟢200200 Ok Async Response

application/json

Body

result

object

required

processId

string

required

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

code

string

required

message

string

required

Example

{
  "result": {
    "processId": "XXXXXXXXXX"
  },
  "requestId": "XXXXXXXXXXXXXXXXXXXX",
  "elapsedMilliseconds": 2000,
  "status": {
    "code": "200",
    "message": "Ok"
  }
}

🔴500500 Error Response

🟠401401 Error - Unauthorized