Image Properties [application/json]

Request body description

Name	Type	Mandatory	Description
fileBase64	String	Yes, if qrCodeField or fileUrl are not provided	Binary file to be proccessed, encoded in a text string according to the RFC3548 standard using base64 encoding.
fileUrl	String	Yes, if qrCodeField or fileUrl are not provided	Public URL of the file to be proccessed.
filePassword	String	Yes, if the submitted file is an encrypted PDF	Password encoded in a base64 string, as PDFs allow passwords to be binary data.

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params application/json

fileBase64

string

required

fileUrl

string

required

filePassword

string

required

Example

{
    "fileBase64":"",
    "fileUrl":"",
    "filePassword":""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200200 Ok Response

application/json

Body

result

array [object {1}]

required

extractions

array [object {2}]

optional

requestId

string

required

elapsedMilliseconds

integer

required

status

object

required

message

string

required

code

string

required

errors

null

required

Example

{
    "result": [
        {
            "extractions": [
                {
                    "source": "compute-grayscale",
                    "sections": [
                        {
                            "pages": [
                                {
                                    "number": 1,
                                    "score": 0.34
                                },
                                {
                                    "number": 2,
                                    "score": 0.41
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "requestId": "gzP3Ix8PB0iWf8EZvbW1j",
    "elapsedMilliseconds": 2034,
    "status": {
        "message": "Ok",
        "code": "200",
        "errors": null
    }
}

Image Properties [application/json]

Request body description#

Request

Request samples

Responses

Request body description