Content Extraction [multipart/form-data]

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params multipart/form-data

file

required

Binary of the file to be processed.

fileUrl

string

required

Public Url of the file to be processed.

filePassword

string

required

Required if the submitted file is a password-encrypted PDF. The password must be encoded in a base64 string, since PDF files allow passwords to be binary data.

returnImage

string

required

If true, returns the binary clipping of the typified images with the corrected perspective.

Example:

false

returnedImageQuality

string

required

It's not mandatory. Allows you to set the quality of the returned deskew image in the extraction path. The attribute is optional, and its default value (when not reporting) is 75.

returnCrops

string

required

If true, it returns the clippings of binary images contained within a standardized document with corrected perspective, such as photo clippings, signature, barcode and fingerprint. Refer to the list of read documents to view all available crops.

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=""'

Responses

🟢200200 Ok Sync

application/json

Body

result

array [object {7}]

required

fields

array [object {3}]

optional

image

null

optional

score

number

optional

type

string

optional

pageNumber

integer

optional

tags

array[string]

optional

tables

array

optional

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

code

string

required

message

string

required

Example

{
  "result": [
    {
      "fields": [
        {
          "name": "nome",
          "value": "XXXXXXXX XXXXXXX XX XXXXX",
          "score": 0.9
        },
        {
          "name": "rg",
          "value": "XXXXXXXX",
          "score": 0.9
        }
      ],
      "image": null,
      "score": 0.9,
      "type": "rg",
      "pageNumber": 1,
      "tags": [
        "br-rg-1"
      ],
      "tables": []
    }
  ],
  "requestId": "XXXXXXXXXXXXXXXXXXXX",
  "elapsedMilliseconds": 2000,
  "status": {
    "code": "200",
    "message": "Ok"
  }
}

🟢200200 Ok Async Response

🔴500500 Error Response